The "addresses" collection of methods.
More...
|
| aggregatedList ($project, $optParams=array()) |
| Retrieves the list of addresses grouped by scope.
|
|
| call ($name, $arguments, $expected_class=null) |
| TODO: This function needs simplifying.
|
|
| delete ($project, $region, $address, $optParams=array()) |
| Deletes the specified address resource.
|
|
| get ($project, $region, $address, $optParams=array()) |
| Returns the specified address resource.
|
|
| insert ($project, $region, Google_Service_Compute_Address $postBody, $optParams=array()) |
| Creates an address resource in the specified project using the data included in the request.
|
|
| listAddresses ($project, $region, $optParams=array()) |
| Retrieves the list of address resources contained within the specified region.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "addresses" collection of methods.
Typical usage is: $computeService = new Google_Service_Compute(...); $addresses = $computeService->addresses;
◆ aggregatedList()
Google_Service_Compute_Addresses_Resource::aggregatedList |
( |
| $project, |
|
|
| $optParams = array() ) |
Retrieves the list of addresses grouped by scope.
(addresses.aggregatedList)
- Parameters
-
string | $project | Project ID for this request. |
array | $optParams | Optional parameters. |
@opt_param string filter 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.
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 (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.
For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.
- Return values
-
◆ call()
Google_Service_Resource::call |
( |
| $name, |
|
|
| $arguments, |
|
|
| $expected_class = null ) |
|
inherited |
TODO: This function needs simplifying.
- Parameters
-
$name | |
$arguments | |
$expected_class | - optional, the expected class name |
- Return values
-
Google_Http_Request|expected_class | |
- Exceptions
-
◆ delete()
Google_Service_Compute_Addresses_Resource::delete |
( |
| $project, |
|
|
| $region, |
|
|
| $address, |
|
|
| $optParams = array() ) |
Deletes the specified address resource.
(addresses.delete)
- Parameters
-
string | $project | Project ID for this request. |
string | $region | The name of the region for this request. |
string | $address | Name of the address resource to delete. |
array | $optParams | Optional parameters. |
- Return values
-
◆ get()
Google_Service_Compute_Addresses_Resource::get |
( |
| $project, |
|
|
| $region, |
|
|
| $address, |
|
|
| $optParams = array() ) |
Returns the specified address resource.
(addresses.get)
- Parameters
-
string | $project | Project ID for this request. |
string | $region | The name of the region for this request. |
string | $address | Name of the address resource to return. |
array | $optParams | Optional parameters. |
- Return values
-
◆ insert()
Creates an address resource in the specified project using the data included in the request.
(addresses.insert)
- Parameters
-
string | $project | Project ID for this request. |
string | $region | The name of the region for this request. |
Google_Address | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ listAddresses()
Google_Service_Compute_Addresses_Resource::listAddresses |
( |
| $project, |
|
|
| $region, |
|
|
| $optParams = array() ) |
Retrieves the list of address resources contained within the specified region.
(addresses.listAddresses)
- Parameters
-
string | $project | Project ID for this request. |
string | $region | The name of the region for this request. |
array | $optParams | Optional parameters. |
@opt_param string filter 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.
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 (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.
For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.
- Return values
-
The documentation for this class was generated from the following file:
- lib/google/src/Google/Service/Compute.php