1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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.subnetworks.html">subnetworks</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79 <p class="firstline">Retrieves an aggregated list of subnetworks.</p> 80 <p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82 <p class="firstline">Retrieves the next page of results.</p> 83 <p class="toc_element"> 84 <code><a href="#delete">delete(project, region, subnetwork)</a></code></p> 85 <p class="firstline">Deletes the specified subnetwork.</p> 86 <p class="toc_element"> 87 <code><a href="#expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</a></code></p> 88 <p class="firstline">Expands the IP CIDR range of the subnetwork to a specified value.</p> 89 <p class="toc_element"> 90 <code><a href="#get">get(project, region, subnetwork)</a></code></p> 91 <p class="firstline">Returns the specified subnetwork. Get a list of available subnetworks list() request.</p> 92 <p class="toc_element"> 93 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource)</a></code></p> 94 <p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 95 <p class="toc_element"> 96 <code><a href="#insert">insert(project, region, body)</a></code></p> 97 <p class="firstline">Creates a subnetwork in the specified project using the data included in the request.</p> 98 <p class="toc_element"> 99 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 100 <p class="firstline">Retrieves a list of subnetworks available to the specified project.</p> 101 <p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103 <p class="firstline">Retrieves the next page of results.</p> 104 <p class="toc_element"> 105 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body)</a></code></p> 106 <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 107 <p class="toc_element"> 108 <code><a href="#setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</a></code></p> 109 <p class="firstline">Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.</p> 110 <p class="toc_element"> 111 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 112 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 113 <h3>Method Details</h3> 114 <div class="method"> 115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 116 <pre>Retrieves an aggregated list of subnetworks. 117 118 Args: 119 project: string, Project ID for this request. (required) 120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 121 122 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. 123 124 Currently, only sorting by name or creationTimestamp desc is supported. 125 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) 126 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. 127 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 128 129 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 130 131 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 132 133 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 134 135 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 136 137 Returns: 138 An object of the form: 139 140 { 141 "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. 142 "items": { # [Output] A map of scoped Subnetwork lists. 143 "a_key": { # Name of the scope containing this set of Subnetworks. 144 "subnetworks": [ # List of subnetworks contained in this scope. 145 { # A Subnetwork resource. 146 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 147 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 148 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 149 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 150 "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. 151 { # Represents a secondary IP range of a subnetwork. 152 "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. 153 "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. 154 }, 155 ], 156 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 157 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 158 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 159 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 160 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 161 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 162 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 163 }, 164 ], 165 "warning": { # An informational warning that appears when the list of addresses is empty. 166 "message": "A String", # [Output Only] A human-readable description of the warning code. 167 "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. 168 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 169 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 170 { 171 "value": "A String", # [Output Only] A warning data value corresponding to the key. 172 "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). 173 }, 174 ], 175 }, 176 }, 177 }, 178 "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. 179 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 180 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 181 }</pre> 182 </div> 183 184 <div class="method"> 185 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 186 <pre>Retrieves the next page of results. 187 188 Args: 189 previous_request: The request for the previous page. (required) 190 previous_response: The response from the request for the previous page. (required) 191 192 Returns: 193 A request object that you can call 'execute()' on to request the next 194 page. Returns None if there are no more items in the collection. 195 </pre> 196 </div> 197 198 <div class="method"> 199 <code class="details" id="delete">delete(project, region, subnetwork)</code> 200 <pre>Deletes the specified subnetwork. 201 202 Args: 203 project: string, Project ID for this request. (required) 204 region: string, Name of the region scoping this request. (required) 205 subnetwork: string, Name of the Subnetwork resource to delete. (required) 206 207 Returns: 208 An object of the form: 209 210 { # An Operation resource, used to manage asynchronous API requests. 211 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 212 "clientOperationId": "A String", # [Output Only] Reserved for future use. 213 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 214 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 215 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 216 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 217 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 218 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 219 "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. 220 "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. 221 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 222 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 223 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 224 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 225 { 226 "message": "A String", # [Output Only] A human-readable description of the warning code. 227 "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. 228 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 229 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 230 { 231 "value": "A String", # [Output Only] A warning data value corresponding to the key. 232 "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). 233 }, 234 ], 235 }, 236 ], 237 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 238 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 239 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 240 "name": "A String", # [Output Only] Name of the resource. 241 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 242 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 243 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 244 { 245 "message": "A String", # [Output Only] An optional, human-readable error message. 246 "code": "A String", # [Output Only] The error type identifier for this error. 247 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 248 }, 249 ], 250 }, 251 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 252 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 253 "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. 254 }</pre> 255 </div> 256 257 <div class="method"> 258 <code class="details" id="expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</code> 259 <pre>Expands the IP CIDR range of the subnetwork to a specified value. 260 261 Args: 262 project: string, Project ID for this request. (required) 263 region: string, Name of the region scoping this request. (required) 264 subnetwork: string, Name of the Subnetwork resource to update. (required) 265 body: object, The request body. (required) 266 The object takes the form of: 267 268 { 269 "ipCidrRange": "A String", # The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. 270 } 271 272 273 Returns: 274 An object of the form: 275 276 { # An Operation resource, used to manage asynchronous API requests. 277 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 278 "clientOperationId": "A String", # [Output Only] Reserved for future use. 279 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 280 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 281 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 282 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 283 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 284 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 285 "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. 286 "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. 287 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 288 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 289 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 290 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 291 { 292 "message": "A String", # [Output Only] A human-readable description of the warning code. 293 "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. 294 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 295 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 296 { 297 "value": "A String", # [Output Only] A warning data value corresponding to the key. 298 "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). 299 }, 300 ], 301 }, 302 ], 303 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 304 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 305 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 306 "name": "A String", # [Output Only] Name of the resource. 307 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 308 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 309 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 310 { 311 "message": "A String", # [Output Only] An optional, human-readable error message. 312 "code": "A String", # [Output Only] The error type identifier for this error. 313 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 314 }, 315 ], 316 }, 317 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 318 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 319 "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. 320 }</pre> 321 </div> 322 323 <div class="method"> 324 <code class="details" id="get">get(project, region, subnetwork)</code> 325 <pre>Returns the specified subnetwork. Get a list of available subnetworks list() request. 326 327 Args: 328 project: string, Project ID for this request. (required) 329 region: string, Name of the region scoping this request. (required) 330 subnetwork: string, Name of the Subnetwork resource to return. (required) 331 332 Returns: 333 An object of the form: 334 335 { # A Subnetwork resource. 336 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 337 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 338 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 339 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 340 "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. 341 { # Represents a secondary IP range of a subnetwork. 342 "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. 343 "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. 344 }, 345 ], 346 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 347 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 348 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 349 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 350 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 351 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 352 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 353 }</pre> 354 </div> 355 356 <div class="method"> 357 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource)</code> 358 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 359 360 Args: 361 project: string, Project ID for this request. (required) 362 region: string, The name of the region for this request. (required) 363 resource: string, Name of the resource for this request. (required) 364 365 Returns: 366 An object of the form: 367 368 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 369 # 370 # 371 # 372 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 373 # 374 # **Example** 375 # 376 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 377 # 378 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 379 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 380 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. 381 # 382 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. 383 # 384 # Example Policy with multiple AuditConfigs: 385 # 386 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 387 # 388 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 389 "exemptedMembers": [ 390 "A String", 391 ], 392 "auditLogConfigs": [ # The configuration for logging of each type of permission. 393 { # Provides the configuration for logging a type of permissions. Example: 394 # 395 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 396 # 397 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 398 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 399 "A String", 400 ], 401 "logType": "A String", # The log type that this config enables. 402 }, 403 ], 404 "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. 405 }, 406 ], 407 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 408 { # A rule to be applied in a Policy. 409 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 410 { # Specifies what kind of log the caller must write 411 "counter": { # Options for counters # Counter options. 412 "field": "A String", # The field value to attribute. 413 "metric": "A String", # The metric to update. 414 }, 415 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 416 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 417 }, 418 }, 419 ], 420 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 421 "A String", 422 ], 423 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 424 "A String", 425 ], 426 "action": "A String", # Required 427 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 428 "A String", 429 ], 430 "conditions": [ # Additional restrictions that must be met 431 { # A condition to be met. 432 "iam": "A String", # Trusted attributes supplied by the IAM system. 433 "svc": "A String", # Trusted attributes discharged by the service. 434 "value": "A String", # DEPRECATED. Use 'values' instead. 435 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 436 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 437 "A String", 438 ], 439 "op": "A String", # An operator to apply the subject with. 440 }, 441 ], 442 "description": "A String", # Human-readable description of the rule. 443 }, 444 ], 445 "version": 42, # Version of the `Policy`. The default version is 0. 446 "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. 447 # 448 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 449 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 450 { # Associates `members` with a `role`. 451 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 452 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 453 # 454 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 455 # 456 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 457 # 458 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 459 # 460 # 461 # 462 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 463 # 464 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 465 # 466 # 467 # 468 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 469 "A String", 470 ], 471 }, 472 ], 473 "iamOwned": True or False, 474 }</pre> 475 </div> 476 477 <div class="method"> 478 <code class="details" id="insert">insert(project, region, body)</code> 479 <pre>Creates a subnetwork in the specified project using the data included in the request. 480 481 Args: 482 project: string, Project ID for this request. (required) 483 region: string, Name of the region scoping this request. (required) 484 body: object, The request body. (required) 485 The object takes the form of: 486 487 { # A Subnetwork resource. 488 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 489 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 490 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 491 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 492 "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. 493 { # Represents a secondary IP range of a subnetwork. 494 "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. 495 "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. 496 }, 497 ], 498 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 499 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 500 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 501 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 502 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 503 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 504 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 505 } 506 507 508 Returns: 509 An object of the form: 510 511 { # An Operation resource, used to manage asynchronous API requests. 512 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 513 "clientOperationId": "A String", # [Output Only] Reserved for future use. 514 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 515 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 516 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 517 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 518 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 519 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 520 "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. 521 "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. 522 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 523 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 524 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 525 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 526 { 527 "message": "A String", # [Output Only] A human-readable description of the warning code. 528 "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. 529 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 530 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 531 { 532 "value": "A String", # [Output Only] A warning data value corresponding to the key. 533 "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). 534 }, 535 ], 536 }, 537 ], 538 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 539 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 540 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 541 "name": "A String", # [Output Only] Name of the resource. 542 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 543 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 544 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 545 { 546 "message": "A String", # [Output Only] An optional, human-readable error message. 547 "code": "A String", # [Output Only] The error type identifier for this error. 548 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 549 }, 550 ], 551 }, 552 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 553 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 554 "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. 555 }</pre> 556 </div> 557 558 <div class="method"> 559 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 560 <pre>Retrieves a list of subnetworks available to the specified project. 561 562 Args: 563 project: string, Project ID for this request. (required) 564 region: string, Name of the region scoping this request. (required) 565 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 566 567 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. 568 569 Currently, only sorting by name or creationTimestamp desc is supported. 570 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) 571 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. 572 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 573 574 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 575 576 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 577 578 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 579 580 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 581 582 Returns: 583 An object of the form: 584 585 { # Contains a list of Subnetwork resources. 586 "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. 587 "items": [ # The Subnetwork resources. 588 { # A Subnetwork resource. 589 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 590 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 591 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 592 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 593 "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. 594 { # Represents a secondary IP range of a subnetwork. 595 "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. 596 "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. 597 }, 598 ], 599 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 600 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 601 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 602 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 603 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 604 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 605 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 606 }, 607 ], 608 "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. 609 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 610 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 611 }</pre> 612 </div> 613 614 <div class="method"> 615 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 616 <pre>Retrieves the next page of results. 617 618 Args: 619 previous_request: The request for the previous page. (required) 620 previous_response: The response from the request for the previous page. (required) 621 622 Returns: 623 A request object that you can call 'execute()' on to request the next 624 page. Returns None if there are no more items in the collection. 625 </pre> 626 </div> 627 628 <div class="method"> 629 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body)</code> 630 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 631 632 Args: 633 project: string, Project ID for this request. (required) 634 region: string, The name of the region for this request. (required) 635 resource: string, Name of the resource for this request. (required) 636 body: object, The request body. (required) 637 The object takes the form of: 638 639 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 640 # 641 # 642 # 643 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 644 # 645 # **Example** 646 # 647 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 648 # 649 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 650 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 651 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. 652 # 653 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. 654 # 655 # Example Policy with multiple AuditConfigs: 656 # 657 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 658 # 659 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 660 "exemptedMembers": [ 661 "A String", 662 ], 663 "auditLogConfigs": [ # The configuration for logging of each type of permission. 664 { # Provides the configuration for logging a type of permissions. Example: 665 # 666 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 667 # 668 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 669 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 670 "A String", 671 ], 672 "logType": "A String", # The log type that this config enables. 673 }, 674 ], 675 "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. 676 }, 677 ], 678 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 679 { # A rule to be applied in a Policy. 680 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 681 { # Specifies what kind of log the caller must write 682 "counter": { # Options for counters # Counter options. 683 "field": "A String", # The field value to attribute. 684 "metric": "A String", # The metric to update. 685 }, 686 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 687 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 688 }, 689 }, 690 ], 691 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 692 "A String", 693 ], 694 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 695 "A String", 696 ], 697 "action": "A String", # Required 698 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 699 "A String", 700 ], 701 "conditions": [ # Additional restrictions that must be met 702 { # A condition to be met. 703 "iam": "A String", # Trusted attributes supplied by the IAM system. 704 "svc": "A String", # Trusted attributes discharged by the service. 705 "value": "A String", # DEPRECATED. Use 'values' instead. 706 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 707 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 708 "A String", 709 ], 710 "op": "A String", # An operator to apply the subject with. 711 }, 712 ], 713 "description": "A String", # Human-readable description of the rule. 714 }, 715 ], 716 "version": 42, # Version of the `Policy`. The default version is 0. 717 "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. 718 # 719 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 720 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 721 { # Associates `members` with a `role`. 722 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 723 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 724 # 725 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 726 # 727 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 728 # 729 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 730 # 731 # 732 # 733 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 734 # 735 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 736 # 737 # 738 # 739 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 740 "A String", 741 ], 742 }, 743 ], 744 "iamOwned": True or False, 745 } 746 747 748 Returns: 749 An object of the form: 750 751 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 752 # 753 # 754 # 755 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 756 # 757 # **Example** 758 # 759 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 760 # 761 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 762 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 763 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. 764 # 765 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. 766 # 767 # Example Policy with multiple AuditConfigs: 768 # 769 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 770 # 771 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 772 "exemptedMembers": [ 773 "A String", 774 ], 775 "auditLogConfigs": [ # The configuration for logging of each type of permission. 776 { # Provides the configuration for logging a type of permissions. Example: 777 # 778 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 779 # 780 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 781 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 782 "A String", 783 ], 784 "logType": "A String", # The log type that this config enables. 785 }, 786 ], 787 "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. 788 }, 789 ], 790 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 791 { # A rule to be applied in a Policy. 792 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 793 { # Specifies what kind of log the caller must write 794 "counter": { # Options for counters # Counter options. 795 "field": "A String", # The field value to attribute. 796 "metric": "A String", # The metric to update. 797 }, 798 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 799 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 800 }, 801 }, 802 ], 803 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 804 "A String", 805 ], 806 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 807 "A String", 808 ], 809 "action": "A String", # Required 810 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 811 "A String", 812 ], 813 "conditions": [ # Additional restrictions that must be met 814 { # A condition to be met. 815 "iam": "A String", # Trusted attributes supplied by the IAM system. 816 "svc": "A String", # Trusted attributes discharged by the service. 817 "value": "A String", # DEPRECATED. Use 'values' instead. 818 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 819 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 820 "A String", 821 ], 822 "op": "A String", # An operator to apply the subject with. 823 }, 824 ], 825 "description": "A String", # Human-readable description of the rule. 826 }, 827 ], 828 "version": 42, # Version of the `Policy`. The default version is 0. 829 "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. 830 # 831 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 832 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 833 { # Associates `members` with a `role`. 834 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 835 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 836 # 837 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 838 # 839 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 840 # 841 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 842 # 843 # 844 # 845 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 846 # 847 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 848 # 849 # 850 # 851 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 852 "A String", 853 ], 854 }, 855 ], 856 "iamOwned": True or False, 857 }</pre> 858 </div> 859 860 <div class="method"> 861 <code class="details" id="setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</code> 862 <pre>Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. 863 864 Args: 865 project: string, Project ID for this request. (required) 866 region: string, Name of the region scoping this request. (required) 867 subnetwork: string, Name of the Subnetwork resource. (required) 868 body: object, The request body. (required) 869 The object takes the form of: 870 871 { 872 "privateIpGoogleAccess": True or False, 873 } 874 875 876 Returns: 877 An object of the form: 878 879 { # An Operation resource, used to manage asynchronous API requests. 880 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 881 "clientOperationId": "A String", # [Output Only] Reserved for future use. 882 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 883 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 884 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 885 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 886 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 887 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 888 "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. 889 "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. 890 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 891 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 892 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 893 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 894 { 895 "message": "A String", # [Output Only] A human-readable description of the warning code. 896 "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. 897 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 898 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 899 { 900 "value": "A String", # [Output Only] A warning data value corresponding to the key. 901 "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). 902 }, 903 ], 904 }, 905 ], 906 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 907 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 908 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 909 "name": "A String", # [Output Only] Name of the resource. 910 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 911 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 912 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 913 { 914 "message": "A String", # [Output Only] An optional, human-readable error message. 915 "code": "A String", # [Output Only] The error type identifier for this error. 916 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 917 }, 918 ], 919 }, 920 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 921 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 922 "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. 923 }</pre> 924 </div> 925 926 <div class="method"> 927 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 928 <pre>Returns permissions that a caller has on the specified resource. 929 930 Args: 931 project: string, Project ID for this request. (required) 932 region: string, The name of the region for this request. (required) 933 resource: string, Name of the resource for this request. (required) 934 body: object, The request body. (required) 935 The object takes the form of: 936 937 { 938 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 939 "A String", 940 ], 941 } 942 943 944 Returns: 945 An object of the form: 946 947 { 948 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 949 "A String", 950 ], 951 }</pre> 952 </div> 953 954 </body></html>
