The "forwardingRules" collection of methods.
More...
|
| aggregatedList ($project, $optParams=array()) |
| Retrieves the list of forwarding rules grouped by scope.
|
|
| call ($name, $arguments, $expected_class=null) |
| TODO: This function needs simplifying.
|
|
| delete ($project, $region, $forwardingRule, $optParams=array()) |
| Deletes the specified ForwardingRule resource.
|
|
| get ($project, $region, $forwardingRule, $optParams=array()) |
| Returns the specified ForwardingRule resource.
|
|
| insert ($project, $region, Google_Service_Compute_ForwardingRule $postBody, $optParams=array()) |
| Creates a ForwardingRule resource in the specified project and region using the data included in the request.
|
|
| listForwardingRules ($project, $region, $optParams=array()) |
| Retrieves the list of ForwardingRule resources available to the specified project and region.
|
|
| setTarget ($project, $region, $forwardingRule, Google_Service_Compute_TargetReference $postBody, $optParams=array()) |
| Changes target url for forwarding rule.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "forwardingRules" collection of methods.
Typical usage is: $computeService = new Google_Service_Compute(...); $forwardingRules = $computeService->forwardingRules;
◆ aggregatedList()
Google_Service_Compute_ForwardingRules_Resource::aggregatedList |
( |
| $project, |
|
|
| $optParams = array() ) |
Retrieves the list of forwarding rules grouped by scope.
(forwardingRules.aggregatedList)
- Parameters
-
string | $project | Name of the project scoping 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_ForwardingRules_Resource::delete |
( |
| $project, |
|
|
| $region, |
|
|
| $forwardingRule, |
|
|
| $optParams = array() ) |
Deletes the specified ForwardingRule resource.
(forwardingRules.delete)
- Parameters
-
string | $project | Name of the project scoping this request. |
string | $region | Name of the region scoping this request. |
string | $forwardingRule | Name of the ForwardingRule resource to delete. |
array | $optParams | Optional parameters. |
- Return values
-
◆ get()
Google_Service_Compute_ForwardingRules_Resource::get |
( |
| $project, |
|
|
| $region, |
|
|
| $forwardingRule, |
|
|
| $optParams = array() ) |
Returns the specified ForwardingRule resource.
(forwardingRules.get)
- Parameters
-
string | $project | Name of the project scoping this request. |
string | $region | Name of the region scoping this request. |
string | $forwardingRule | Name of the ForwardingRule resource to return. |
array | $optParams | Optional parameters. |
- Return values
-
◆ insert()
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
(forwardingRules.insert)
- Parameters
-
string | $project | Name of the project scoping this request. |
string | $region | Name of the region scoping this request. |
Google_ForwardingRule | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ listForwardingRules()
Google_Service_Compute_ForwardingRules_Resource::listForwardingRules |
( |
| $project, |
|
|
| $region, |
|
|
| $optParams = array() ) |
Retrieves the list of ForwardingRule resources available to the specified project and region.
(forwardingRules.listForwardingRules)
- Parameters
-
string | $project | Name of the project scoping this request. |
string | $region | Name of the region scoping 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
-
◆ setTarget()
Changes target url for forwarding rule.
(forwardingRules.setTarget)
- Parameters
-
string | $project | Name of the project scoping this request. |
string | $region | Name of the region scoping this request. |
string | $forwardingRule | Name of the ForwardingRule resource in which target is to be set. |
Google_TargetReference | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
The documentation for this class was generated from the following file:
- lib/google/src/Google/Service/Compute.php