Documentation

Google_Service_ServiceNetworking_Resource_Services extends Google_Service_Resource
in package

The "services" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addSubnetwork()  : Google_Service_ServiceNetworking_Operation
For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
disableVpcServiceControls()  : Google_Service_ServiceNetworking_Operation
Disables VPC service controls for a connection.
enableVpcServiceControls()  : Google_Service_ServiceNetworking_Operation
Enables VPC service controls for a connection.
searchRange()  : Google_Service_ServiceNetworking_Operation
Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation).
validate()  : Google_Service_ServiceNetworking_ValidateConsumerConfigResponse
Service producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.
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

addSubnetwork()

For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed.

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

(services.addSubnetwork)

Parameters
$parent : string

Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id }/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only projects are supported. {resource-id} is the tenant project numeric id, such as 123456. {service} the name of the peering service, such as service-peering.example.com. This service must already be enabled in the service consumer's project.

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

Optional parameters.

Return values
Google_Service_ServiceNetworking_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

disableVpcServiceControls()

Disables VPC service controls for a connection.

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

(services.disableVpcServiceControls)

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_DisableVpcServiceControlsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ServiceNetworking_Operation

enableVpcServiceControls()

Enables VPC service controls for a connection.

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

(services.enableVpcServiceControls)

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_EnableVpcServiceControlsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ServiceNetworking_Operation

searchRange()

Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation).

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

(services.searchRange)

Parameters
$parent : string

Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'.

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

Optional parameters.

Return values
Google_Service_ServiceNetworking_Operation

validate()

Service producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.

public validate(string $parent, Google_Service_ServiceNetworking_ValidateConsumerConfigRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceNetworking_ValidateConsumerConfigResponse

(services.validate)

Parameters
$parent : string

Required. This is in a form services/{service} where {service} is the name of the private access management service. For example 'service-peering.example.com'.

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

Optional parameters.

Return values
Google_Service_ServiceNetworking_ValidateConsumerConfigResponse

convertToArrayAndStripNulls()

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

Search results