Documentation

Google_Service_Compute_Resource_Routers extends Google_Service_Resource
in package

The "routers" collection of methods.

Typical usage is: $computeService = new Google_Service_Compute(...); $routers = $computeService->routers;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
aggregatedList()  : Google_Service_Compute_RouterAggregatedList
Retrieves an aggregated list of routers. (routers.aggregatedList)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Compute_Operation
Deletes the specified Router resource. (routers.delete)
get()  : Google_Service_Compute_Router
Returns the specified Router resource. Gets a list of available routers by making a list() request. (routers.get)
getNatMappingInfo()  : Google_Service_Compute_VmEndpointNatMappingsList
Retrieves runtime Nat mapping information of VM endpoints.
getRouterStatus()  : Google_Service_Compute_RouterStatusResponse
Retrieves runtime information of the specified router.
insert()  : Google_Service_Compute_Operation
Creates a Router resource in the specified project and region using the data included in the request. (routers.insert)
listRouters()  : Google_Service_Compute_RouterList
Retrieves a list of Router resources available to the specified project.
patch()  : Google_Service_Compute_Operation
Patches the specified Router resource with the data included in the request.
preview()  : Google_Service_Compute_RoutersPreviewResponse
Preview fields auto-generated during router create and update operations.
update()  : Google_Service_Compute_Operation
Updates the specified Router resource with the data included in the request.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

aggregatedList()

Retrieves an aggregated list of routers. (routers.aggregatedList)

public aggregatedList(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_RouterAggregatedList
Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

bool includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

opt_param

string maxResults 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)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

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.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_RouterAggregatedList —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes the specified Router resource. (routers.delete)

public delete(string $project, string $region, string $router[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$router : string

Name of the Router resource to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

get()

Returns the specified Router resource. Gets a list of available routers by making a list() request. (routers.get)

public get(string $project, string $region, string $router[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Router
Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$router : string

Name of the Router resource to return.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_Router —

getNatMappingInfo()

Retrieves runtime Nat mapping information of VM endpoints.

public getNatMappingInfo(string $project, string $region, string $router[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_VmEndpointNatMappingsList

(routers.getNatMappingInfo)

Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$router : string

Name of the Router resource to query for Nat Mapping information of VM endpoints.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

string maxResults 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)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

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.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_VmEndpointNatMappingsList —

getRouterStatus()

Retrieves runtime information of the specified router.

public getRouterStatus(string $project, string $region, string $router[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_RouterStatusResponse

(routers.getRouterStatus)

Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$router : string

Name of the Router resource to query.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_RouterStatusResponse —

insert()

Creates a Router resource in the specified project and region using the data included in the request. (routers.insert)

public insert(string $project, string $region, Google_Service_Compute_Router $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$postBody : Google_Service_Compute_Router
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

listRouters()

Retrieves a list of Router resources available to the specified project.

public listRouters(string $project, string $region[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_RouterList

(routers.listRouters)

Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

string maxResults 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)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

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.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_RouterList —

patch()

Patches the specified Router resource with the data included in the request.

public patch(string $project, string $region, string $router, Google_Service_Compute_Router $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

This method supports PATCH semantics and uses JSON merge patch format and processing rules. (routers.patch)

Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$router : string

Name of the Router resource to patch.

$postBody : Google_Service_Compute_Router
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

preview()

Preview fields auto-generated during router create and update operations.

public preview(string $project, string $region, string $router, Google_Service_Compute_Router $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_RoutersPreviewResponse

Calling this method does NOT create or update the router. (routers.preview)

Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$router : string

Name of the Router resource to query.

$postBody : Google_Service_Compute_Router
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_RoutersPreviewResponse —

update()

Updates the specified Router resource with the data included in the request.

public update(string $project, string $region, string $router, Google_Service_Compute_Router $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. (routers.update)

Parameters
$project : string

Project ID for this request.

$region : string

Name of the region for this request.

$router : string

Name of the Router resource to update.

$postBody : Google_Service_Compute_Router
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results