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.globalAddresses.html">globalAddresses</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(project, address)</a></code></p> 79 <p class="firstline">Deletes the specified address resource.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(project, address)</a></code></p> 82 <p class="firstline">Returns the specified address resource. Get a list of available addresses by making a list() request.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(project, body)</a></code></p> 85 <p class="firstline">Creates an address resource in the specified project using the data included in the request.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 88 <p class="firstline">Retrieves a list of global addresses.</p> 89 <p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91 <p class="firstline">Retrieves the next page of results.</p> 92 <p class="toc_element"> 93 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 94 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="delete">delete(project, address)</code> 98 <pre>Deletes the specified address resource. 99 100 Args: 101 project: string, Project ID for this request. (required) 102 address: string, Name of the address resource to delete. (required) 103 104 Returns: 105 An object of the form: 106 107 { # An Operation resource, used to manage asynchronous API requests. 108 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 109 "clientOperationId": "A String", # [Output Only] Reserved for future use. 110 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 111 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 112 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 113 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 114 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 115 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 116 "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. 117 "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. 118 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 119 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 120 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 121 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 122 { 123 "message": "A String", # [Output Only] A human-readable description of the warning code. 124 "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. 125 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 126 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 127 { 128 "value": "A String", # [Output Only] A warning data value corresponding to the key. 129 "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). 130 }, 131 ], 132 }, 133 ], 134 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 135 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 136 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 137 "name": "A String", # [Output Only] Name of the resource. 138 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 139 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 140 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 141 { 142 "message": "A String", # [Output Only] An optional, human-readable error message. 143 "code": "A String", # [Output Only] The error type identifier for this error. 144 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 145 }, 146 ], 147 }, 148 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 149 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 150 "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. 151 }</pre> 152 </div> 153 154 <div class="method"> 155 <code class="details" id="get">get(project, address)</code> 156 <pre>Returns the specified address resource. Get a list of available addresses by making a list() request. 157 158 Args: 159 project: string, Project ID for this request. (required) 160 address: string, Name of the address resource to return. (required) 161 162 Returns: 163 An object of the form: 164 165 { # A reserved address resource. 166 "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. 167 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 168 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 169 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 170 "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. 171 "address": "A String", # The static external IP address represented by this resource. 172 "users": [ # [Output Only] The URLs of the resources that are using this address. 173 "A String", 174 ], 175 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 176 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 177 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 178 "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. 179 }</pre> 180 </div> 181 182 <div class="method"> 183 <code class="details" id="insert">insert(project, body)</code> 184 <pre>Creates an address resource in the specified project using the data included in the request. 185 186 Args: 187 project: string, Project ID for this request. (required) 188 body: object, The request body. (required) 189 The object takes the form of: 190 191 { # A reserved address resource. 192 "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. 193 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 194 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 195 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 196 "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. 197 "address": "A String", # The static external IP address represented by this resource. 198 "users": [ # [Output Only] The URLs of the resources that are using this address. 199 "A String", 200 ], 201 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 202 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 203 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 204 "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. 205 } 206 207 208 Returns: 209 An object of the form: 210 211 { # An Operation resource, used to manage asynchronous API requests. 212 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 213 "clientOperationId": "A String", # [Output Only] Reserved for future use. 214 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 215 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 216 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 217 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 218 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 219 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 220 "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. 221 "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. 222 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 223 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 224 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 225 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 226 { 227 "message": "A String", # [Output Only] A human-readable description of the warning code. 228 "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. 229 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 230 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 231 { 232 "value": "A String", # [Output Only] A warning data value corresponding to the key. 233 "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). 234 }, 235 ], 236 }, 237 ], 238 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 239 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 240 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 241 "name": "A String", # [Output Only] Name of the resource. 242 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 243 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 244 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 245 { 246 "message": "A String", # [Output Only] An optional, human-readable error message. 247 "code": "A String", # [Output Only] The error type identifier for this error. 248 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 249 }, 250 ], 251 }, 252 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 253 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 254 "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. 255 }</pre> 256 </div> 257 258 <div class="method"> 259 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 260 <pre>Retrieves a list of global addresses. 261 262 Args: 263 project: string, Project ID for this request. (required) 264 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 265 266 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. 267 268 Currently, only sorting by name or creationTimestamp desc is supported. 269 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) 270 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. 271 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. 272 273 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. 274 275 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 276 277 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. 278 279 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. 280 281 Returns: 282 An object of the form: 283 284 { # Contains a list of addresses. 285 "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. 286 "items": [ # [Output Only] A list of addresses. 287 { # A reserved address resource. 288 "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. 289 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. 290 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 291 "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. 292 "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. 293 "address": "A String", # The static external IP address represented by this resource. 294 "users": [ # [Output Only] The URLs of the resources that are using this address. 295 "A String", 296 ], 297 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 298 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 299 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 300 "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. 301 }, 302 ], 303 "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses. 304 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 305 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 306 }</pre> 307 </div> 308 309 <div class="method"> 310 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 311 <pre>Retrieves the next page of results. 312 313 Args: 314 previous_request: The request for the previous page. (required) 315 previous_response: The response from the request for the previous page. (required) 316 317 Returns: 318 A request object that you can call 'execute()' on to request the next 319 page. Returns None if there are no more items in the collection. 320 </pre> 321 </div> 322 323 <div class="method"> 324 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 325 <pre>Returns permissions that a caller has on the specified resource. 326 327 Args: 328 project: string, Project ID for this request. (required) 329 resource: string, Name of the resource for this request. (required) 330 body: object, The request body. (required) 331 The object takes the form of: 332 333 { 334 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 335 "A String", 336 ], 337 } 338 339 340 Returns: 341 An object of the form: 342 343 { 344 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 345 "A String", 346 ], 347 }</pre> 348 </div> 349 350 </body></html>
