Documentation

Google_Service_Compute_Resource_Networks extends Google_Service_Resource
in package

The "networks" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addPeering()  : Google_Service_Compute_Operation
Adds a peering to the specified network. (networks.addPeering)
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 network. (networks.delete)
get()  : Google_Service_Compute_Network
Returns the specified network. Gets a list of available networks by making a list() request. (networks.get)
insert()  : Google_Service_Compute_Operation
Creates a network in the specified project using the data included in the request. (networks.insert)
listNetworks()  : Google_Service_Compute_NetworkList
Retrieves the list of networks available to the specified project.
listPeeringRoutes()  : Google_Service_Compute_ExchangedPeeringRoutesList
Lists the peering routes exchanged over peering connection.
patch()  : Google_Service_Compute_Operation
Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (networks.patch)
removePeering()  : Google_Service_Compute_Operation
Removes a peering from the specified network. (networks.removePeering)
switchToCustomMode()  : Google_Service_Compute_Operation
Switches the network mode from auto subnet mode to custom subnet mode.
updatePeering()  : Google_Service_Compute_Operation
Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (networks.updatePeering)
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 —

addPeering()

Adds a peering to the specified network. (networks.addPeering)

public addPeering(string $project, string $network, Google_Service_Compute_NetworksAddPeeringRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$network : string

Name of the network resource to add peering to.

$postBody : Google_Service_Compute_NetworksAddPeeringRequest
$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 —

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 network. (networks.delete)

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

Project ID for this request.

$network : string

Name of the network 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 network. Gets a list of available networks by making a list() request. (networks.get)

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

Project ID for this request.

$network : string

Name of the network to return.

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

Optional parameters.

Return values
Google_Service_Compute_Network —

insert()

Creates a network in the specified project using the data included in the request. (networks.insert)

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

Project ID for this request.

$postBody : Google_Service_Compute_Network
$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 —

listNetworks()

Retrieves the list of networks available to the specified project.

public listNetworks(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NetworkList

(networks.listNetworks)

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

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_NetworkList —

listPeeringRoutes()

Lists the peering routes exchanged over peering connection.

public listPeeringRoutes(string $project, string $network[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_ExchangedPeeringRoutesList

(networks.listPeeringRoutes)

Parameters
$project : string

Project ID for this request.

$network : string

Name of the network for this request.

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

Optional parameters.

Tags
opt_param

string direction The direction of the exchanged routes.

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

string peeringName The response will show routes exchanged over the given peering connection.

opt_param

string region The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.

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_ExchangedPeeringRoutesList —

patch()

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (networks.patch)

public patch(string $project, string $network, Google_Service_Compute_Network $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$network : string

Name of the network to update.

$postBody : Google_Service_Compute_Network
$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 —

removePeering()

Removes a peering from the specified network. (networks.removePeering)

public removePeering(string $project, string $network, Google_Service_Compute_NetworksRemovePeeringRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$network : string

Name of the network resource to remove peering from.

$postBody : Google_Service_Compute_NetworksRemovePeeringRequest
$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 —

switchToCustomMode()

Switches the network mode from auto subnet mode to custom subnet mode.

public switchToCustomMode(string $project, string $network[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

(networks.switchToCustomMode)

Parameters
$project : string

Project ID for this request.

$network : string

Name of the network to be updated.

$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 —

updatePeering()

Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (networks.updatePeering)

public updatePeering(string $project, string $network, Google_Service_Compute_NetworksUpdatePeeringRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$network : string

Name of the network resource which the updated peering is belonging to.

$postBody : Google_Service_Compute_NetworksUpdatePeeringRequest
$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