Reference documentation and code samples for the Compute V1 Client class VpnGatewaysClient.
Service Description: The VpnGateways API.
This class is currently experimental and may be subject to changes.
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 VPN gateways.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::aggregatedListAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListVpnGatewaysRequest
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 VPN gateway.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteVpnGatewayRequest
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 VPN gateway.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetVpnGatewayRequest
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\VpnGateway |
getStatus
Returns the status for the specified VPN gateway.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::getStatusAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetStatusVpnGatewayRequest
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\VpnGatewaysGetStatusResponse |
insert
Creates a VPN gateway in the specified project and region using the data included in the request.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertVpnGatewayRequest
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 VPN gateways available to the specified project and region.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListVpnGatewaysRequest
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 |
setLabels
Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::setLabelsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsVpnGatewayRequest
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\BaseClient\self::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsVpnGatewayRequest
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\AggregatedListVpnGatewaysRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteVpnGatewayRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetVpnGatewayRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getStatusAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetStatusVpnGatewayRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertVpnGatewayRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListVpnGatewaysRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setLabelsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsVpnGatewayRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsVpnGatewayRequest
|
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 |