Documentation

Google_Service_ServiceNetworking_Resource_ServicesConnections extends Google_Service_Resource
in package

The "connections" collection of methods.

Typical usage is: $servicenetworkingService = new Google_Service_ServiceNetworking(...); $connections = $servicenetworkingService->connections;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_ServiceNetworking_Operation
Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once. (connections.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listServicesConnections()  : Google_Service_ServiceNetworking_ListConnectionsResponse
List the private connections that are configured in a service consumer's VPC network. (connections.listServicesConnections)
patch()  : Google_Service_ServiceNetworking_Operation
Updates the allocated ranges that are assigned to a connection.
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

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

create()

Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once. (connections.create)

public create(string $parent, Google_Service_ServiceNetworking_Connection $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceNetworking_Operation
Parameters
$parent : string

The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.

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

Optional parameters.

Return values
Google_Service_ServiceNetworking_Operation

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

listServicesConnections()

List the private connections that are configured in a service consumer's VPC network. (connections.listServicesConnections)

public listServicesConnections(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceNetworking_ListConnectionsResponse
Parameters
$parent : string

The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com. If you specify services/- as the parameter value, all configured peering services are listed.

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

Optional parameters.

Tags
opt_param

string network The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: projects/{project}/global/networks/{network}. {project} is a project number, such as in 12345 that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network.

Return values
Google_Service_ServiceNetworking_ListConnectionsResponse

patch()

Updates the allocated ranges that are assigned to a connection.

public patch(string $name, Google_Service_ServiceNetworking_Connection $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceNetworking_Operation

(connections.patch)

Parameters
$name : string

The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of services/{peering_service_name}/connections/{vpc_peering_name}. For Google services that support this functionality, this is services/servicenetworking.googleapis.com/connections/servicenetworking- googleapis-com.

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

Optional parameters.

Tags
opt_param

string updateMask The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges.

opt_param

bool force If a previously defined allocated range is removed, force flag must be set to true.

Return values
Google_Service_ServiceNetworking_Operation

convertToArrayAndStripNulls()

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

Search results