Reference documentation and code samples for the Compute V1 Client class SubnetworksClient.
Service Description: The Subnetworks API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
aggregatedList
Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::aggregatedListAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListSubnetworksRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
delete
Deletes the specified subnetwork.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteSubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
expandIpCidrRange
Expands the IP CIDR range of the subnetwork to a specified value.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::expandIpCidrRangeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ExpandIpCidrRangeSubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
get
Returns the specified subnetwork.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetSubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Subnetwork |
getIamPolicy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicySubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Policy |
insert
Creates a subnetwork in the specified project using the data included in the request.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertSubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
list
Retrieves a list of subnetworks available to the specified project.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListSubnetworksRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listUsable
Retrieves an aggregated list of all usable subnetworks in the project.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::listUsableAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListUsableSubnetworksRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
patch
Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::patchAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PatchSubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicySubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Policy |
setPrivateIpGoogleAccess
Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::setPrivateIpGoogleAccessAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetPrivateIpGoogleAccessSubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
testIamPermissions
Returns permissions that a caller has on the specified resource.
The async variant is Google\Cloud\Compute\V1\Client\SubnetworksClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsSubnetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\TestPermissionsResponse |
aggregatedListAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListSubnetworksRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteSubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
expandIpCidrRangeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ExpandIpCidrRangeSubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetSubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicySubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertSubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListSubnetworksRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listUsableAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListUsableSubnetworksRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
patchAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PatchSubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicySubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setPrivateIpGoogleAccessAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetPrivateIpGoogleAccessSubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsSubnetworkRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\RegionOperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |