1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.licenses.html">licenses</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, license, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. </p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, license, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. </p> 86<p class="toc_element"> 87 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. </p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. </p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. </p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. </p> 101<p class="toc_element"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. </p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="delete">delete(project, license, requestId=None, x__xgafv=None)</code> 112 <pre>Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 113 114Args: 115 project: string, Project ID for this request. (required) 116 license: string, Name of the license resource to delete. (required) 117 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 126 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 127 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 128 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 129 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 130 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 131 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 132 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 133 { 134 "code": "A String", # [Output Only] The error type identifier for this error. 135 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 136 "message": "A String", # [Output Only] An optional, human-readable error message. 137 }, 138 ], 139 }, 140 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 141 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 142 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 143 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 144 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 145 "name": "A String", # [Output Only] Name of the operation. 146 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 147 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 148 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 149 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 150 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 151 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 152 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 153 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 154 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 155 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 156 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 157 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 158 { 159 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 160 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 161 { 162 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 163 "value": "A String", # [Output Only] A warning data value corresponding to the key. 164 }, 165 ], 166 "message": "A String", # [Output Only] A human-readable description of the warning code. 167 }, 168 ], 169 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 170}</pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="get">get(project, license, x__xgafv=None)</code> 175 <pre>Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 176 177Args: 178 project: string, Project ID for this request. (required) 179 license: string, Name of the License resource to return. (required) 180 x__xgafv: string, V1 error format. 181 Allowed values 182 1 - v1 error format 183 2 - v2 error format 184 185Returns: 186 An object of the form: 187 188 { # Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 189 "chargesUseFee": True or False, # [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. 190 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 191 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 192 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 193 "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses. 194 "licenseCode": "A String", # [Output Only] The unique code used to attach this license to images, snapshots, and disks. 195 "name": "A String", # Name of the resource. The name must be 1-63 characters long and comply with RFC1035. 196 "resourceRequirements": { 197 "minGuestCpuCount": 42, # Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. 198 "minMemoryMb": 42, # Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. 199 }, 200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 201 "transferable": True or False, # If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. 202}</pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 207 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 208 209Args: 210 project: string, Project ID for this request. (required) 211 resource: string, Name or id of the resource for this request. (required) 212 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 213 x__xgafv: string, V1 error format. 214 Allowed values 215 1 - v1 error format 216 2 - v2 error format 217 218Returns: 219 An object of the form: 220 221 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 222 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 223 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 224 "auditLogConfigs": [ # The configuration for logging of each type of permission. 225 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 226 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 227 "A String", 228 ], 229 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 230 "logType": "A String", # The log type that this config enables. 231 }, 232 ], 233 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 234 "A String", 235 ], 236 "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. 237 }, 238 ], 239 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 240 { # Associates `members`, or principals, with a `role`. 241 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 242 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 243 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 244 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 245 "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. 246 "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. 247 }, 248 "members": [ # Specifies the principals requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 249 "A String", 250 ], 251 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 252 }, 253 ], 254 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 255 "rules": [ # This is deprecated and has no effect. Do not use. 256 { # This is deprecated and has no effect. Do not use. 257 "action": "A String", # This is deprecated and has no effect. Do not use. 258 "conditions": [ # This is deprecated and has no effect. Do not use. 259 { # This is deprecated and has no effect. Do not use. 260 "iam": "A String", # This is deprecated and has no effect. Do not use. 261 "op": "A String", # This is deprecated and has no effect. Do not use. 262 "svc": "A String", # This is deprecated and has no effect. Do not use. 263 "sys": "A String", # This is deprecated and has no effect. Do not use. 264 "values": [ # This is deprecated and has no effect. Do not use. 265 "A String", 266 ], 267 }, 268 ], 269 "description": "A String", # This is deprecated and has no effect. Do not use. 270 "ins": [ # This is deprecated and has no effect. Do not use. 271 "A String", 272 ], 273 "logConfigs": [ # This is deprecated and has no effect. Do not use. 274 { # This is deprecated and has no effect. Do not use. 275 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 276 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 277 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 278 }, 279 "logName": "A String", # This is deprecated and has no effect. Do not use. 280 }, 281 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 282 "customFields": [ # This is deprecated and has no effect. Do not use. 283 { # This is deprecated and has no effect. Do not use. 284 "name": "A String", # This is deprecated and has no effect. Do not use. 285 "value": "A String", # This is deprecated and has no effect. Do not use. 286 }, 287 ], 288 "field": "A String", # This is deprecated and has no effect. Do not use. 289 "metric": "A String", # This is deprecated and has no effect. Do not use. 290 }, 291 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 292 "logMode": "A String", # This is deprecated and has no effect. Do not use. 293 }, 294 }, 295 ], 296 "notIns": [ # This is deprecated and has no effect. Do not use. 297 "A String", 298 ], 299 "permissions": [ # This is deprecated and has no effect. Do not use. 300 "A String", 301 ], 302 }, 303 ], 304 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 305}</pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 310 <pre>Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 311 312Args: 313 project: string, Project ID for this request. (required) 314 body: object, The request body. 315 The object takes the form of: 316 317{ # Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 318 "chargesUseFee": True or False, # [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. 319 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 320 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 321 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 322 "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses. 323 "licenseCode": "A String", # [Output Only] The unique code used to attach this license to images, snapshots, and disks. 324 "name": "A String", # Name of the resource. The name must be 1-63 characters long and comply with RFC1035. 325 "resourceRequirements": { 326 "minGuestCpuCount": 42, # Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. 327 "minMemoryMb": 42, # Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. 328 }, 329 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 330 "transferable": True or False, # If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. 331} 332 333 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 334 x__xgafv: string, V1 error format. 335 Allowed values 336 1 - v1 error format 337 2 - v2 error format 338 339Returns: 340 An object of the form: 341 342 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 343 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 344 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 345 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 346 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 347 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 348 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 349 { 350 "code": "A String", # [Output Only] The error type identifier for this error. 351 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 352 "message": "A String", # [Output Only] An optional, human-readable error message. 353 }, 354 ], 355 }, 356 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 357 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 358 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 359 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 360 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 361 "name": "A String", # [Output Only] Name of the operation. 362 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 363 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 364 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 365 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 366 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 367 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 368 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 369 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 370 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 371 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 372 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 373 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 374 { 375 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 376 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 377 { 378 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 379 "value": "A String", # [Output Only] A warning data value corresponding to the key. 380 }, 381 ], 382 "message": "A String", # [Output Only] A human-readable description of the warning code. 383 }, 384 ], 385 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 386}</pre> 387</div> 388 389<div class="method"> 390 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 391 <pre>Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 392 393Args: 394 project: string, Project ID for this request. (required) 395 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 396 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 397 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 398 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. 399 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 400 x__xgafv: string, V1 error format. 401 Allowed values 402 1 - v1 error format 403 2 - v2 error format 404 405Returns: 406 An object of the form: 407 408 { 409 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 410 "items": [ # A list of License resources. 411 { # Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 412 "chargesUseFee": True or False, # [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. 413 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 414 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 415 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 416 "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses. 417 "licenseCode": "A String", # [Output Only] The unique code used to attach this license to images, snapshots, and disks. 418 "name": "A String", # Name of the resource. The name must be 1-63 characters long and comply with RFC1035. 419 "resourceRequirements": { 420 "minGuestCpuCount": 42, # Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. 421 "minMemoryMb": 42, # Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. 422 }, 423 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 424 "transferable": True or False, # If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. 425 }, 426 ], 427 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 428 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 429 "warning": { # [Output Only] Informational warning message. 430 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 431 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 432 { 433 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 434 "value": "A String", # [Output Only] A warning data value corresponding to the key. 435 }, 436 ], 437 "message": "A String", # [Output Only] A human-readable description of the warning code. 438 }, 439}</pre> 440</div> 441 442<div class="method"> 443 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 444 <pre>Retrieves the next page of results. 445 446Args: 447 previous_request: The request for the previous page. (required) 448 previous_response: The response from the request for the previous page. (required) 449 450Returns: 451 A request object that you can call 'execute()' on to request the next 452 page. Returns None if there are no more items in the collection. 453 </pre> 454</div> 455 456<div class="method"> 457 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code> 458 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 459 460Args: 461 project: string, Project ID for this request. (required) 462 resource: string, Name or id of the resource for this request. (required) 463 body: object, The request body. 464 The object takes the form of: 465 466{ 467 "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. 468 { # Associates `members`, or principals, with a `role`. 469 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 470 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 471 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 472 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 473 "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. 474 "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. 475 }, 476 "members": [ # Specifies the principals requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 477 "A String", 478 ], 479 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 480 }, 481 ], 482 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 483 "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:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. 484 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 485 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 486 "auditLogConfigs": [ # The configuration for logging of each type of permission. 487 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 488 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 489 "A String", 490 ], 491 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 492 "logType": "A String", # The log type that this config enables. 493 }, 494 ], 495 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 496 "A String", 497 ], 498 "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. 499 }, 500 ], 501 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 502 { # Associates `members`, or principals, with a `role`. 503 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 504 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 505 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 506 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 507 "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. 508 "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. 509 }, 510 "members": [ # Specifies the principals requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 511 "A String", 512 ], 513 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 514 }, 515 ], 516 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 517 "rules": [ # This is deprecated and has no effect. Do not use. 518 { # This is deprecated and has no effect. Do not use. 519 "action": "A String", # This is deprecated and has no effect. Do not use. 520 "conditions": [ # This is deprecated and has no effect. Do not use. 521 { # This is deprecated and has no effect. Do not use. 522 "iam": "A String", # This is deprecated and has no effect. Do not use. 523 "op": "A String", # This is deprecated and has no effect. Do not use. 524 "svc": "A String", # This is deprecated and has no effect. Do not use. 525 "sys": "A String", # This is deprecated and has no effect. Do not use. 526 "values": [ # This is deprecated and has no effect. Do not use. 527 "A String", 528 ], 529 }, 530 ], 531 "description": "A String", # This is deprecated and has no effect. Do not use. 532 "ins": [ # This is deprecated and has no effect. Do not use. 533 "A String", 534 ], 535 "logConfigs": [ # This is deprecated and has no effect. Do not use. 536 { # This is deprecated and has no effect. Do not use. 537 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 538 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 539 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 540 }, 541 "logName": "A String", # This is deprecated and has no effect. Do not use. 542 }, 543 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 544 "customFields": [ # This is deprecated and has no effect. Do not use. 545 { # This is deprecated and has no effect. Do not use. 546 "name": "A String", # This is deprecated and has no effect. Do not use. 547 "value": "A String", # This is deprecated and has no effect. Do not use. 548 }, 549 ], 550 "field": "A String", # This is deprecated and has no effect. Do not use. 551 "metric": "A String", # This is deprecated and has no effect. Do not use. 552 }, 553 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 554 "logMode": "A String", # This is deprecated and has no effect. Do not use. 555 }, 556 }, 557 ], 558 "notIns": [ # This is deprecated and has no effect. Do not use. 559 "A String", 560 ], 561 "permissions": [ # This is deprecated and has no effect. Do not use. 562 "A String", 563 ], 564 }, 565 ], 566 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 567 }, 568} 569 570 x__xgafv: string, V1 error format. 571 Allowed values 572 1 - v1 error format 573 2 - v2 error format 574 575Returns: 576 An object of the form: 577 578 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 579 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 580 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 581 "auditLogConfigs": [ # The configuration for logging of each type of permission. 582 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 583 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 584 "A String", 585 ], 586 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 587 "logType": "A String", # The log type that this config enables. 588 }, 589 ], 590 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 591 "A String", 592 ], 593 "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. 594 }, 595 ], 596 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 597 { # Associates `members`, or principals, with a `role`. 598 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 599 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 600 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 601 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 602 "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. 603 "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. 604 }, 605 "members": [ # Specifies the principals requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 606 "A String", 607 ], 608 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 609 }, 610 ], 611 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 612 "rules": [ # This is deprecated and has no effect. Do not use. 613 { # This is deprecated and has no effect. Do not use. 614 "action": "A String", # This is deprecated and has no effect. Do not use. 615 "conditions": [ # This is deprecated and has no effect. Do not use. 616 { # This is deprecated and has no effect. Do not use. 617 "iam": "A String", # This is deprecated and has no effect. Do not use. 618 "op": "A String", # This is deprecated and has no effect. Do not use. 619 "svc": "A String", # This is deprecated and has no effect. Do not use. 620 "sys": "A String", # This is deprecated and has no effect. Do not use. 621 "values": [ # This is deprecated and has no effect. Do not use. 622 "A String", 623 ], 624 }, 625 ], 626 "description": "A String", # This is deprecated and has no effect. Do not use. 627 "ins": [ # This is deprecated and has no effect. Do not use. 628 "A String", 629 ], 630 "logConfigs": [ # This is deprecated and has no effect. Do not use. 631 { # This is deprecated and has no effect. Do not use. 632 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 633 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 634 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 635 }, 636 "logName": "A String", # This is deprecated and has no effect. Do not use. 637 }, 638 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 639 "customFields": [ # This is deprecated and has no effect. Do not use. 640 { # This is deprecated and has no effect. Do not use. 641 "name": "A String", # This is deprecated and has no effect. Do not use. 642 "value": "A String", # This is deprecated and has no effect. Do not use. 643 }, 644 ], 645 "field": "A String", # This is deprecated and has no effect. Do not use. 646 "metric": "A String", # This is deprecated and has no effect. Do not use. 647 }, 648 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 649 "logMode": "A String", # This is deprecated and has no effect. Do not use. 650 }, 651 }, 652 ], 653 "notIns": [ # This is deprecated and has no effect. Do not use. 654 "A String", 655 ], 656 "permissions": [ # This is deprecated and has no effect. Do not use. 657 "A String", 658 ], 659 }, 660 ], 661 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 662}</pre> 663</div> 664 665<div class="method"> 666 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 667 <pre>Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. 668 669Args: 670 project: string, Project ID for this request. (required) 671 resource: string, Name or id of the resource for this request. (required) 672 body: object, The request body. 673 The object takes the form of: 674 675{ 676 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 677 "A String", 678 ], 679} 680 681 x__xgafv: string, V1 error format. 682 Allowed values 683 1 - v1 error format 684 2 - v2 error format 685 686Returns: 687 An object of the form: 688 689 { 690 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 691 "A String", 692 ], 693}</pre> 694</div> 695 696</body></html>