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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.addresses.html">addresses</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 addresses.</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, address, requestId=None)</a></code></p> 85 <p class="firstline">Deletes the specified address resource.</p> 86 <p class="toc_element"> 87 <code><a href="#get">get(project, region, address)</a></code></p> 88 <p class="firstline">Returns the specified address resource.</p> 89 <p class="toc_element"> 90 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p> 91 <p class="firstline">Creates an address resource in the specified project using the data included in the request.</p> 92 <p class="toc_element"> 93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94 <p class="firstline">Retrieves a list of addresses contained within the specified region.</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="#setLabels">setLabels(project, region, resource, body, requestId=None)</a></code></p> 100 <p class="firstline">Sets the labels on an Address. To learn more about labels, read the Labeling or Tagging Resources documentation.</p> 101 <p class="toc_element"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 103 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 104 <h3>Method Details</h3> 105 <div class="method"> 106 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 107 <pre>Retrieves an aggregated list of addresses. 108 109 Args: 110 project: string, Project ID for this request. (required) 111 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 112 113 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. 114 115 Currently, only sorting by name or creationTimestamp desc is supported. 116 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) 117 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. 118 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. 119 120 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. 121 122 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 123 124 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. 125 126 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. 127 128 Returns: 129 An object of the form: 130 131 { 132 "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. 133 "items": { # [Output Only] A map of scoped address lists. 134 "a_key": { # [Output Only] Name of the scope containing this set of addresses. 135 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty. 136 "message": "A String", # [Output Only] A human-readable description of the warning code. 137 "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. 138 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 139 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 140 { 141 "value": "A String", # [Output Only] A warning data value corresponding to the key. 142 "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). 143 }, 144 ], 145 }, 146 "addresses": [ # [Output Only] List of addresses contained in this scope. 147 { # A reserved address resource. 148 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 149 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 150 "addressType": "A String", # The type of address to reserve. If unspecified, defaults to EXTERNAL. 151 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 152 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 153 # 154 # To see the latest fingerprint, make a get() request to retrieve an Address. 155 "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 156 "a_key": "A String", 157 }, 158 "ipVersion": "A String", # The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. 159 "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 160 "users": [ # [Output Only] The URLs of the resources that are using this address. 161 "A String", 162 ], 163 "address": "A String", # The static external IP address represented by this resource. 164 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 165 "subnetwork": "A String", # For external addresses, this field should not be used. 166 # 167 # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. 168 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 169 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 170 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 171 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 172 }, 173 ], 174 }, 175 }, 176 "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. 177 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 178 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 179 }</pre> 180 </div> 181 182 <div class="method"> 183 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 184 <pre>Retrieves the next page of results. 185 186 Args: 187 previous_request: The request for the previous page. (required) 188 previous_response: The response from the request for the previous page. (required) 189 190 Returns: 191 A request object that you can call 'execute()' on to request the next 192 page. Returns None if there are no more items in the collection. 193 </pre> 194 </div> 195 196 <div class="method"> 197 <code class="details" id="delete">delete(project, region, address, requestId=None)</code> 198 <pre>Deletes the specified address resource. 199 200 Args: 201 project: string, Project ID for this request. (required) 202 region: string, Name of the region for this request. (required) 203 address: string, Name of the address resource to delete. (required) 204 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 205 206 Returns: 207 An object of the form: 208 209 { # An Operation resource, used to manage asynchronous API requests. 210 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 211 "clientOperationId": "A String", # [Output Only] Reserved for future use. 212 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 213 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 214 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 215 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 216 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 217 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 218 "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. 219 "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. 220 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 221 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 222 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 223 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 224 { 225 "message": "A String", # [Output Only] A human-readable description of the warning code. 226 "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. 227 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 228 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 229 { 230 "value": "A String", # [Output Only] A warning data value corresponding to the key. 231 "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). 232 }, 233 ], 234 }, 235 ], 236 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 237 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 238 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 239 "name": "A String", # [Output Only] Name of the resource. 240 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 241 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 242 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 243 { 244 "message": "A String", # [Output Only] An optional, human-readable error message. 245 "code": "A String", # [Output Only] The error type identifier for this error. 246 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 247 }, 248 ], 249 }, 250 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 251 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 252 "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. 253 }</pre> 254 </div> 255 256 <div class="method"> 257 <code class="details" id="get">get(project, region, address)</code> 258 <pre>Returns the specified address resource. 259 260 Args: 261 project: string, Project ID for this request. (required) 262 region: string, Name of the region for this request. (required) 263 address: string, Name of the address resource to return. (required) 264 265 Returns: 266 An object of the form: 267 268 { # A reserved address resource. 269 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 270 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 271 "addressType": "A String", # The type of address to reserve. If unspecified, defaults to EXTERNAL. 272 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 273 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 274 # 275 # To see the latest fingerprint, make a get() request to retrieve an Address. 276 "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 277 "a_key": "A String", 278 }, 279 "ipVersion": "A String", # The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. 280 "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 281 "users": [ # [Output Only] The URLs of the resources that are using this address. 282 "A String", 283 ], 284 "address": "A String", # The static external IP address represented by this resource. 285 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 286 "subnetwork": "A String", # For external addresses, this field should not be used. 287 # 288 # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. 289 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 290 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 291 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 292 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 293 }</pre> 294 </div> 295 296 <div class="method"> 297 <code class="details" id="insert">insert(project, region, body, requestId=None)</code> 298 <pre>Creates an address resource in the specified project using the data included in the request. 299 300 Args: 301 project: string, Project ID for this request. (required) 302 region: string, Name of the region for this request. (required) 303 body: object, The request body. (required) 304 The object takes the form of: 305 306 { # A reserved address resource. 307 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 308 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 309 "addressType": "A String", # The type of address to reserve. If unspecified, defaults to EXTERNAL. 310 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 311 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 312 # 313 # To see the latest fingerprint, make a get() request to retrieve an Address. 314 "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 315 "a_key": "A String", 316 }, 317 "ipVersion": "A String", # The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. 318 "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 319 "users": [ # [Output Only] The URLs of the resources that are using this address. 320 "A String", 321 ], 322 "address": "A String", # The static external IP address represented by this resource. 323 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 324 "subnetwork": "A String", # For external addresses, this field should not be used. 325 # 326 # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. 327 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 328 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 329 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 330 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 331 } 332 333 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 334 335 Returns: 336 An object of the form: 337 338 { # An Operation resource, used to manage asynchronous API requests. 339 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 340 "clientOperationId": "A String", # [Output Only] Reserved for future use. 341 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 342 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 343 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 344 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 345 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 346 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 347 "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. 348 "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. 349 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 350 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 351 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 352 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 353 { 354 "message": "A String", # [Output Only] A human-readable description of the warning code. 355 "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. 356 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 357 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 358 { 359 "value": "A String", # [Output Only] A warning data value corresponding to the key. 360 "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). 361 }, 362 ], 363 }, 364 ], 365 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 366 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 367 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 368 "name": "A String", # [Output Only] Name of the resource. 369 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 370 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 371 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 372 { 373 "message": "A String", # [Output Only] An optional, human-readable error message. 374 "code": "A String", # [Output Only] The error type identifier for this error. 375 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 376 }, 377 ], 378 }, 379 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 380 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 381 "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. 382 }</pre> 383 </div> 384 385 <div class="method"> 386 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 387 <pre>Retrieves a list of addresses contained within the specified region. 388 389 Args: 390 project: string, Project ID for this request. (required) 391 region: string, Name of the region for this request. (required) 392 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 393 394 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. 395 396 Currently, only sorting by name or creationTimestamp desc is supported. 397 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) 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 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. 400 401 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. 402 403 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 404 405 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. 406 407 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. 408 409 Returns: 410 An object of the form: 411 412 { # Contains a list of addresses. 413 "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. 414 "items": [ # [Output Only] A list of addresses. 415 { # A reserved address resource. 416 "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. 417 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 418 "addressType": "A String", # The type of address to reserve. If unspecified, defaults to EXTERNAL. 419 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 420 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 421 # 422 # To see the latest fingerprint, make a get() request to retrieve an Address. 423 "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 424 "a_key": "A String", 425 }, 426 "ipVersion": "A String", # The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. 427 "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 428 "users": [ # [Output Only] The URLs of the resources that are using this address. 429 "A String", 430 ], 431 "address": "A String", # The static external IP address represented by this resource. 432 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 433 "subnetwork": "A String", # For external addresses, this field should not be used. 434 # 435 # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. 436 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 437 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 438 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 439 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 440 }, 441 ], 442 "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses. 443 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 444 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 445 }</pre> 446 </div> 447 448 <div class="method"> 449 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 450 <pre>Retrieves the next page of results. 451 452 Args: 453 previous_request: The request for the previous page. (required) 454 previous_response: The response from the request for the previous page. (required) 455 456 Returns: 457 A request object that you can call 'execute()' on to request the next 458 page. Returns None if there are no more items in the collection. 459 </pre> 460 </div> 461 462 <div class="method"> 463 <code class="details" id="setLabels">setLabels(project, region, resource, body, requestId=None)</code> 464 <pre>Sets the labels on an Address. To learn more about labels, read the Labeling or Tagging Resources documentation. 465 466 Args: 467 project: string, Project ID for this request. (required) 468 region: string, The region for this request. (required) 469 resource: string, Name of the resource for this request. (required) 470 body: object, The request body. (required) 471 The object takes the form of: 472 473 { 474 "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. 475 "labels": { # The labels to set for this resource. 476 "a_key": "A String", 477 }, 478 } 479 480 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 481 482 Returns: 483 An object of the form: 484 485 { # An Operation resource, used to manage asynchronous API requests. 486 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 487 "clientOperationId": "A String", # [Output Only] Reserved for future use. 488 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 489 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 490 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 491 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 492 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 493 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 494 "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. 495 "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. 496 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 497 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 498 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 499 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 500 { 501 "message": "A String", # [Output Only] A human-readable description of the warning code. 502 "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. 503 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 504 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 505 { 506 "value": "A String", # [Output Only] A warning data value corresponding to the key. 507 "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). 508 }, 509 ], 510 }, 511 ], 512 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 513 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 514 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 515 "name": "A String", # [Output Only] Name of the resource. 516 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 517 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 518 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 519 { 520 "message": "A String", # [Output Only] An optional, human-readable error message. 521 "code": "A String", # [Output Only] The error type identifier for this error. 522 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 523 }, 524 ], 525 }, 526 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 527 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 528 "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. 529 }</pre> 530 </div> 531 532 <div class="method"> 533 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 534 <pre>Returns permissions that a caller has on the specified resource. 535 536 Args: 537 project: string, Project ID for this request. (required) 538 region: string, The name of the region for this request. (required) 539 resource: string, Name of the resource for this request. (required) 540 body: object, The request body. (required) 541 The object takes the form of: 542 543 { 544 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 545 "A String", 546 ], 547 } 548 549 550 Returns: 551 An object of the form: 552 553 { 554 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 555 "A String", 556 ], 557 }</pre> 558 </div> 559 560 </body></html>
