diff --git a/CHANGELOG.md b/CHANGELOG.md index 6094731d83c..b527d90fb12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,34 @@ # Changelog +## [2.79.0](https://github.com/googleapis/google-api-python-client/compare/v2.78.0...v2.79.0) (2023-02-21) + + +### Features + +* **alertcenter:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/547eb4a4f6b5577fcb6c80638cc9e93cced35089 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **androidenterprise:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a5c14741ad7ca5b5f53dc4b4fcdab070132639b8 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **baremetalsolution:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1cca20e7cce92036d67e528123414f669ebd942a ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **batch:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/12b1c85fc3280dbbb23c4db396c64dd3601a303d ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **chat:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/bc983e9dd1e8dbc8ec910bbe36321afb81cf33cd ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **chromemanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b204e0fa6f03e35f70774067a52026d38bb90549 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **cloudsearch:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a57ae6337ea0612594b88badfb354b73d68f6a73 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **compute:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/41d899c6514dbb5cf1a9c1358ac777fa19bbf8ae ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **content:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b2704a04c366aedcd1c665f6f34db47bc81e178f ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **drive:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c189a81e8116af6ae96c26a82cbe0662c2f540a2 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **healthcare:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/58ad8a45dcc3b7cd97f2f30c03a0ff9e0bdf1a83 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **logging:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f365cf32684e625b772e60d45ea1dd188983ac25 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **monitoring:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/48090571c1e8a2cb3831a9540363db8051284440 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **networksecurity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/aa9721a9179ece2acf74ca2067d48b11a2acce01 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **ondemandscanning:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f247a051529550f3e55aeb456276bafe327517e8 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **paymentsresellersubscription:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a01ba7b18fb69f14d04e5c4ea67a47945a4b40b7 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **privateca:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5f5a1d83c419e0c3d9aac0746681a384dfc1af69 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **redis:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/edc5f1f9ca6f56cfd945621414c369bff840ee4e ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **safebrowsing:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/940222c83f916b3b90bbacf4436bbf97a949f852 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **serviceconsumermanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ba5bd7229c287f2b0636d1128f057334ca8ec4b9 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **servicecontrol:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6c85d3c5e895805aa9b2e5a73d4d812c449b5388 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **servicenetworking:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/df40666a943166ca27603fb5c14e9b67c711c709 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) +* **serviceusage:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/64cbf8291c51625042a94d6195dfa81e8da63ea7 ([f183bc9](https://github.com/googleapis/google-api-python-client/commit/f183bc9439ca3b0b42de85d670e2c89014263e62)) + ## [2.78.0](https://github.com/googleapis/google-api-python-client/compare/v2.77.0...v2.78.0) (2023-02-14) diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 535448af5ff..2054ae18ee9 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -249,7 +249,7 @@
acknowledgeUserDataCollection(property, body=None, x__xgafv=None)
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
+Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
Close httplib2 connections.
@@ -193,7 +193,7 @@acknowledgeUserDataCollection(property, body=None, x__xgafv=None)
- Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created. +Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created. Args: property: string, Required. The property for which to acknowledge user data collection. (required) @@ -541,7 +541,7 @@@@ -407,7 +421,11 @@Method Details
"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone. }, ], - "dimensionFilter": { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # Dimension filters allow you to restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. + "dimensionFilter": { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. "accessFilter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. diff --git a/docs/dyn/analyticsadmin_v1beta.accounts.html b/docs/dyn/analyticsadmin_v1beta.accounts.html index 0a268cc6a68..25cacfcd6a8 100644 --- a/docs/dyn/analyticsadmin_v1beta.accounts.html +++ b/docs/dyn/analyticsadmin_v1beta.accounts.html @@ -239,7 +239,7 @@Method Details
"updateTime": "A String", # Output only. Time when account payload fields were last updated. } - updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -275,7 +275,7 @@Method Details
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, - "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI + "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/analyticsadmin_v1beta.properties.html b/docs/dyn/analyticsadmin_v1beta.properties.html index 8e8b1fe9a0b..6a057746126 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.html @@ -106,7 +106,7 @@Instance Methods
-
acknowledgeUserDataCollection(property, body=None, x__xgafv=None)
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
+Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
Close httplib2 connections.
@@ -137,7 +137,7 @@Instance Methods
Method Details
@@ -269,7 +276,11 @@acknowledgeUserDataCollection(property, body=None, x__xgafv=None)
-Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created. +Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created. Args: property: string, Required. The property for which to acknowledge user data collection. (required) diff --git a/docs/dyn/analyticsdata_v1beta.properties.html b/docs/dyn/analyticsdata_v1beta.properties.html index c0c88de095e..7615fe27d76 100644 --- a/docs/dyn/analyticsdata_v1beta.properties.html +++ b/docs/dyn/analyticsdata_v1beta.properties.html @@ -449,7 +449,7 @@Method Details
"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone. }, ], - "dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. + "dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship. "expressions": [ # A list of filter expressions. # Object with schema name: FilterExpression @@ -1557,7 +1557,7 @@Method Details
"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone. }, ], - "dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. + "dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship. "expressions": [ # A list of filter expressions. # Object with schema name: FilterExpression diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html index d879c23a381..eaf0f52cd81 100644 --- a/docs/dyn/androidenterprise_v1.devices.html +++ b/docs/dyn/androidenterprise_v1.devices.html @@ -134,7 +134,11 @@Method Details
{ # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0". + "device": "A String", # The internal hardware codename of the device. This comes from android.os.Build.DEVICE. (field named "device" per logs/wireless/android/android_checkin.proto) + "latestBuildFingerprint": "A String", # The build fingerprint of the device if known. + "maker": "A String", # The manufacturer of the device. This comes from android.os.Build.MANUFACTURER. "managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC. + "model": "A String", # The model name of the device. This comes from android.os.Build.MODEL. "policy": { # The device policy for a given managed device. # The policy enforced on the device. "autoUpdatePolicy": "A String", # Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi. "deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled". @@ -209,6 +213,7 @@Method Details
}, ], }, + "product": "A String", # The product name of the device. This comes from android.os.Build.PRODUCT. "report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states. "appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present. { # List of states set by the app. @@ -226,6 +231,8 @@Method Details
], "lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present. }, + "retailBrand": "A String", # Retail brand for the device, if set. See https://developer.android.com/reference/android/os/Build.html#BRAND + "sdkVersion": 42, # API compatibility version. }Method Details
"device": [ # A managed device. { # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0". + "device": "A String", # The internal hardware codename of the device. This comes from android.os.Build.DEVICE. (field named "device" per logs/wireless/android/android_checkin.proto) + "latestBuildFingerprint": "A String", # The build fingerprint of the device if known. + "maker": "A String", # The manufacturer of the device. This comes from android.os.Build.MANUFACTURER. "managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC. + "model": "A String", # The model name of the device. This comes from android.os.Build.MODEL. "policy": { # The device policy for a given managed device. # The policy enforced on the device. "autoUpdatePolicy": "A String", # Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi. "deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled". @@ -344,6 +355,7 @@Method Details
}, ], }, + "product": "A String", # The product name of the device. This comes from android.os.Build.PRODUCT. "report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states. "appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present. { # List of states set by the app. @@ -361,6 +373,8 @@Method Details
], "lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present. }, + "retailBrand": "A String", # Retail brand for the device, if set. See https://developer.android.com/reference/android/os/Build.html#BRAND + "sdkVersion": 42, # API compatibility version. }, ], }Method Details
{ # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0". + "device": "A String", # The internal hardware codename of the device. This comes from android.os.Build.DEVICE. (field named "device" per logs/wireless/android/android_checkin.proto) + "latestBuildFingerprint": "A String", # The build fingerprint of the device if known. + "maker": "A String", # The manufacturer of the device. This comes from android.os.Build.MANUFACTURER. "managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC. + "model": "A String", # The model name of the device. This comes from android.os.Build.MODEL. "policy": { # The device policy for a given managed device. # The policy enforced on the device. "autoUpdatePolicy": "A String", # Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi. "deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled". @@ -482,6 +500,7 @@Method Details
}, ], }, + "product": "A String", # The product name of the device. This comes from android.os.Build.PRODUCT. "report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states. "appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present. { # List of states set by the app. @@ -499,6 +518,8 @@Method Details
], "lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present. }, + "retailBrand": "A String", # Retail brand for the device, if set. See https://developer.android.com/reference/android/os/Build.html#BRAND + "sdkVersion": 42, # API compatibility version. } updateMask: string, Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=<field1>,<field2>,... @@ -512,7 +533,11 @@Method Details
{ # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0". + "device": "A String", # The internal hardware codename of the device. This comes from android.os.Build.DEVICE. (field named "device" per logs/wireless/android/android_checkin.proto) + "latestBuildFingerprint": "A String", # The build fingerprint of the device if known. + "maker": "A String", # The manufacturer of the device. This comes from android.os.Build.MANUFACTURER. "managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC. + "model": "A String", # The model name of the device. This comes from android.os.Build.MODEL. "policy": { # The device policy for a given managed device. # The policy enforced on the device. "autoUpdatePolicy": "A String", # Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi. "deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled". @@ -587,6 +612,7 @@Method Details
}, ], }, + "product": "A String", # The product name of the device. This comes from android.os.Build.PRODUCT. "report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states. "appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present. { # List of states set by the app. @@ -604,6 +630,8 @@Method Details
], "lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present. }, + "retailBrand": "A String", # Retail brand for the device, if set. See https://developer.android.com/reference/android/os/Build.html#BRAND + "sdkVersion": 42, # API compatibility version. }
RenameInstance sets a new name for an instance. Args: - name: string, Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` (required) + name: string, Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance} (required) body: object, The request body. The object takes the form of: { # Message requesting rename of a server. - "instance": { # A server. # Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance} - "createTime": "A String", # Output only. Create a time stamp. - "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. - "id": "A String", # Output only. An identifier for the `Instance`, generated by the backend. - "interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. - "labels": { # Labels as key value pairs. - "a_key": "A String", - }, - "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled. - { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. - "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. - "logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. - { # Each logical network interface is effectively a network and IP pair. - "defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. - "id": "A String", # An identifier for the `Network`, generated by the backend. - "ipAddress": "A String", # IP address in the network - "network": "A String", # Name of the network - "networkType": "A String", # Type of network. - }, - ], - "name": "A String", # Interface name. This is of syntax or and forms part of the network template name. - }, - ], - "loginInfo": "A String", # Output only. Text field about info for logging in. - "luns": [ # Immutable. List of LUNs associated with this server. - { # A storage volume logical unit number (LUN). - "bootLun": True or False, # Display if this LUN is a boot LUN. - "expireTime": "A String", # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state. - "id": "A String", # An identifier for the LUN, generated by the backend. - "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. - "name": "A String", # Output only. The name of the LUN. - "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. - "sizeGb": "A String", # The size of this LUN, in gigabytes. - "state": "A String", # The state of this storage volume. - "storageType": "A String", # The storage type for this LUN. - "storageVolume": "A String", # Display the storage volume for this LUN. - "wwid": "A String", # The WWID for this LUN. - }, - ], - "machineType": "A String", # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) - "name": "A String", # Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` - "networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic". - "networks": [ # Output only. List of networks associated with this server. - { # A Network. - "cidr": "A String", # The cidr of the Network. - "gatewayIp": "A String", # Output only. Gateway ip address. - "id": "A String", # An identifier for the `Network`, generated by the backend. - "ipAddress": "A String", # IP address configured. - "jumboFramesEnabled": True or False, # Whether network uses standard frames or jumbo ones. - "labels": { # Labels as key value pairs. - "a_key": "A String", - }, - "macAddress": [ # List of physical interfaces. - "A String", - ], - "mountPoints": [ # Input only. List of mount points to attach the network to. - { # Mount point for a network. - "defaultGateway": True or False, # Network should be a default gateway. - "instance": "A String", # Instance to attach network to. - "ipAddress": "A String", # Ip address of the server. - "logicalInterface": "A String", # Logical interface to detach from. - }, - ], - "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` - "pod": "A String", # Output only. Pod name. - "reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server. - { # A reservation of one or more addresses in a network. - "endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2. - "note": "A String", # A note about this reservation, intended for human consumption. - "startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2. - }, - ], - "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS). - "state": "A String", # The Network state. - "type": "A String", # The type of this network. - "vlanId": "A String", # The vlan id of the Network. - "vrf": { # A network VRF. # The vrf for the Network. - "name": "A String", # The name of the VRF. - "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility. - "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps. - }, - "state": "A String", # The possible state of VRF. - "vlanAttachments": [ # The list of VLAN attachments for the VRF. - { # VLAN attachment details. - "id": "A String", # Immutable. The identifier of the attachment within vrf. - "pairingKey": "A String", # Input only. Pairing key. - "peerIp": "A String", # The peer IP of the attachment. - "peerVlanId": "A String", # The peer vlan ID of the attachment. - "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level. - "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps. - }, - "routerIp": "A String", # The router IP of the attachment. - }, - ], - }, - }, - ], - "osImage": "A String", # The OS image currently installed on the server. - "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only. - "state": "A String", # Output only. The state of the server. - "updateTime": "A String", # Output only. Update a time stamp. - "volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. - { # A storage volume. - "autoGrownSizeGib": "A String", # The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0. - "bootVolume": True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN. - "currentSizeGib": "A String", # The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink. - "emergencySizeGib": "A String", # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value. - "expireTime": "A String", # Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state. - "id": "A String", # An identifier for the `Volume`, generated by the backend. - "labels": { # Labels as key value pairs. - "a_key": "A String", - }, - "maxSizeGib": "A String", # Maximum size volume can be expanded to in case of evergency, in GiB. - "name": "A String", # Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}` - "notes": "A String", # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention. - "originallyRequestedSizeGib": "A String", # Originally requested size, in GiB. - "performanceTier": "A String", # Immutable. Performance tier of the Volume. Default is SHARED. - "pod": "A String", # Immutable. Pod name. - "protocol": "A String", # Output only. Storage protocol for the Volume. - "remainingSpaceGib": "A String", # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots. - "requestedSizeGib": "A String", # The requested size of this storage volume, in GiB. - "snapshotAutoDeleteBehavior": "A String", # The behavior to use when snapshot reserved space is full. - "snapshotEnabled": True or False, # Whether snapshots are enabled. - "snapshotReservationDetail": { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume. - "reservedSpaceGib": "A String", # The space on this storage volume reserved for snapshots, shown in GiB. - "reservedSpacePercent": 42, # Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true. - "reservedSpaceRemainingGib": "A String", # The amount, in GiB, of available space in this storage volume's reserved snapshot space. - "reservedSpaceUsedPercent": 42, # The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume. - }, - "snapshotSchedulePolicy": "A String", # The name of the snapshot schedule policy in use for this volume, if any. - "state": "A String", # The state of this storage volume. - "storageAggregatePool": "A String", # Input only. Name of the storage aggregate pool to allocate the volume in. Can be used only for VOLUME_PERFORMANCE_TIER_ASSIGNED volumes. - "storageType": "A String", # The storage type for this volume. - "workloadProfile": "A String", # The workload profile for the volume. - }, - ], - "workloadProfile": "A String", # The workload profile for the instance. - }, - "name": "A String", # Required. The new `name` of the instance. Format: {instancename} + "newName": "A String", # Required. The new `name` of the instance. Format: {instancename} } x__xgafv: string, V1 error format. @@ -1091,24 +953,143 @@diff --git a/docs/dyn/batch_v1.projects.locations.jobs.html b/docs/dyn/batch_v1.projects.locations.jobs.html index 6465c4702cd..0750dc2ae6f 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.html @@ -91,21 +91,12 @@Method Details
Returns: An object of the form: - { # This resource represents a long-running operation that is the result of a network API call. - "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "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 response of the operation in case of success. 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. + { # A server. + "createTime": "A String", # Output only. Create a time stamp. + "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. + "id": "A String", # Output only. An identifier for the `Instance`, generated by the backend. + "interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. + "labels": { # Labels as key value pairs. + "a_key": "A String", }, + "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled. + { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface. + "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. + "logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. + { # Each logical network interface is effectively a network and IP pair. + "defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. + "id": "A String", # An identifier for the `Network`, generated by the backend. + "ipAddress": "A String", # IP address in the network + "network": "A String", # Name of the network + "networkType": "A String", # Type of network. + }, + ], + "name": "A String", # Interface name. This is of syntax or and forms part of the network template name. + }, + ], + "loginInfo": "A String", # Output only. Text field about info for logging in. + "luns": [ # Immutable. List of LUNs associated with this server. + { # A storage volume logical unit number (LUN). + "bootLun": True or False, # Display if this LUN is a boot LUN. + "expireTime": "A String", # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state. + "id": "A String", # An identifier for the LUN, generated by the backend. + "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. + "name": "A String", # Output only. The name of the LUN. + "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. + "sizeGb": "A String", # The size of this LUN, in gigabytes. + "state": "A String", # The state of this storage volume. + "storageType": "A String", # The storage type for this LUN. + "storageVolume": "A String", # Display the storage volume for this LUN. + "wwid": "A String", # The WWID for this LUN. + }, + ], + "machineType": "A String", # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) + "name": "A String", # Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` + "networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic". + "networks": [ # Output only. List of networks associated with this server. + { # A Network. + "cidr": "A String", # The cidr of the Network. + "gatewayIp": "A String", # Output only. Gateway ip address. + "id": "A String", # An identifier for the `Network`, generated by the backend. + "ipAddress": "A String", # IP address configured. + "jumboFramesEnabled": True or False, # Whether network uses standard frames or jumbo ones. + "labels": { # Labels as key value pairs. + "a_key": "A String", + }, + "macAddress": [ # List of physical interfaces. + "A String", + ], + "mountPoints": [ # Input only. List of mount points to attach the network to. + { # Mount point for a network. + "defaultGateway": True or False, # Network should be a default gateway. + "instance": "A String", # Instance to attach network to. + "ipAddress": "A String", # Ip address of the server. + "logicalInterface": "A String", # Logical interface to detach from. + }, + ], + "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` + "pod": "A String", # Output only. Pod name. + "reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server. + { # A reservation of one or more addresses in a network. + "endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2. + "note": "A String", # A note about this reservation, intended for human consumption. + "startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2. + }, + ], + "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS). + "state": "A String", # The Network state. + "type": "A String", # The type of this network. + "vlanId": "A String", # The vlan id of the Network. + "vrf": { # A network VRF. # The vrf for the Network. + "name": "A String", # The name of the VRF. + "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility. + "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps. + }, + "state": "A String", # The possible state of VRF. + "vlanAttachments": [ # The list of VLAN attachments for the VRF. + { # VLAN attachment details. + "id": "A String", # Immutable. The identifier of the attachment within vrf. + "pairingKey": "A String", # Input only. Pairing key. + "peerIp": "A String", # The peer IP of the attachment. + "peerVlanId": "A String", # The peer vlan ID of the attachment. + "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level. + "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps. + }, + "routerIp": "A String", # The router IP of the attachment. + }, + ], + }, + }, + ], + "osImage": "A String", # The OS image currently installed on the server. + "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only. + "state": "A String", # Output only. The state of the server. + "updateTime": "A String", # Output only. Update a time stamp. + "volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. + { # A storage volume. + "autoGrownSizeGib": "A String", # The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0. + "bootVolume": True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN. + "currentSizeGib": "A String", # The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink. + "emergencySizeGib": "A String", # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value. + "expireTime": "A String", # Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state. + "id": "A String", # An identifier for the `Volume`, generated by the backend. + "labels": { # Labels as key value pairs. + "a_key": "A String", + }, + "maxSizeGib": "A String", # Maximum size volume can be expanded to in case of evergency, in GiB. + "name": "A String", # Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}` + "notes": "A String", # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention. + "originallyRequestedSizeGib": "A String", # Originally requested size, in GiB. + "performanceTier": "A String", # Immutable. Performance tier of the Volume. Default is SHARED. + "pod": "A String", # Immutable. Pod name. + "protocol": "A String", # Output only. Storage protocol for the Volume. + "remainingSpaceGib": "A String", # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots. + "requestedSizeGib": "A String", # The requested size of this storage volume, in GiB. + "snapshotAutoDeleteBehavior": "A String", # The behavior to use when snapshot reserved space is full. + "snapshotEnabled": True or False, # Whether snapshots are enabled. + "snapshotReservationDetail": { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume. + "reservedSpaceGib": "A String", # The space on this storage volume reserved for snapshots, shown in GiB. + "reservedSpacePercent": 42, # Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true. + "reservedSpaceRemainingGib": "A String", # The amount, in GiB, of available space in this storage volume's reserved snapshot space. + "reservedSpaceUsedPercent": 42, # The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume. + }, + "snapshotSchedulePolicy": "A String", # The name of the snapshot schedule policy in use for this volume, if any. + "state": "A String", # The state of this storage volume. + "storageAggregatePool": "A String", # Input only. Name of the storage aggregate pool to allocate the volume in. Can be used only for VOLUME_PERFORMANCE_TIER_ASSIGNED volumes. + "storageType": "A String", # The storage type for this volume. + "workloadProfile": "A String", # The workload profile for the volume. + }, + ], + "workloadProfile": "A String", # The workload profile for the instance. }
Get a Job specified by its resource name.
-
- 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, pageSize=None, pageToken=None, x__xgafv=None)
List all Jobs for a project within a region.
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.
-
- 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.
close()
@@ -204,7 +195,7 @@ 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`. * `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. - "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`. - }, - ], - "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows 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, pageSize=None, pageToken=None, x__xgafv=None)
List all Jobs for a project within a region. @@ -1051,7 +994,7 @@Method Details
"pubsubTopic": "A String", # The Pub/Sub topic where notifications like the job state changes will be published. This topic exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: `projects/{project}/topics/{topic}`. }, ], - "priority": "A String", # Priority of the Job. The valid value range is [0, 100). A job with higher priority value is more likely to run earlier if all other requirements are satisfied. + "priority": "A String", # Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied. "status": { # Job status. # Output only. Job status. It is read only for users. "runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state @@ -1131,9 +1074,9 @@Method Details
"environments": { # Deprecated: please use environment(non-plural) instead. "a_key": "A String", }, - "lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. The valid size of lifecycle policies are [0, 10]. For each lifecycle policy, when the condition is met, the action in that policy will execute. If there are multiple policies that the task execution result matches, we use the action from the first matched policy. If task execution result does not meet with any of the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count. + "lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count. { # LifecyclePolicy describes how to deal with task failures based on different conditions. - "action": "A String", # Action to execute when ActionCondition is true. + "action": "A String", # Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found. "actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action. "exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed. 42, @@ -1228,119 +1171,4 @@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`. * `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. - "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`. - }, - ], - "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows 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`. * `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. - "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`. - }, - ], - "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows 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", - ], -}-