Google Cloud Vmware Engine V1 Client - Class VmwareEngineClient (0.2.1)

Version 0.2.1

• 0.5.6 (latest)
• 0.5.5
• 0.4.0
• 0.3.3
• 0.2.1
• 0.1.4

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class VmwareEngineClient.

Service Description: VMwareEngine manages VMware's private clusters in the Cloud.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ VmwareEngine \ V1 \ Client

Methods

__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 false.
↳ 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. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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 = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods 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.

createCluster

Creates a new cluster in a given private cloud.

Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::createClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateClusterRequest 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

createHcxActivationKey

Creates a new HCX activation key in a given private cloud.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::createHcxActivationKeyAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateHcxActivationKeyRequest 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

createNetworkPolicy

Creates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network policy already exists in the same scope.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::createNetworkPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateNetworkPolicyRequest 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

createPrivateCloud

Creates a new PrivateCloud resource in a given project and location.

Private clouds can only be created in zones, regional private clouds are not supported.

Creating a private cloud also creates a management cluster for that private cloud.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::createPrivateCloudAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreatePrivateCloudRequest 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

createVmwareEngineNetwork

Creates a new VMware Engine network that can be used by a private cloud.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::createVmwareEngineNetworkAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateVmwareEngineNetworkRequest 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

deleteCluster

Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion.

You cannot delete the management cluster of a private cloud using this method.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::deleteClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeleteClusterRequest 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

deleteNetworkPolicy

Deletes a NetworkPolicy resource. A network policy cannot be deleted when NetworkService.state is set to RECONCILING for either its external IP or internet access service.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::deleteNetworkPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeleteNetworkPolicyRequest 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

deletePrivateCloud

Schedules a PrivateCloud resource for deletion.

A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and expireTime set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud is successfully scheduled for deletion (this also applies when delayHours is set to zero), and the operation is not kept in pending state until PrivateCloud is purged. PrivateCloud can be restored using UndeletePrivateCloud method before the expireTime elapses. When expireTime is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state is set to PURGING. PrivateCloud can be polled using standard GET method for the whole period of deletion and purging. It will not be returned only when it is completely purged.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::deletePrivateCloudAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeletePrivateCloudRequest 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

deleteVmwareEngineNetwork

Deletes a VmwareEngineNetwork resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::deleteVmwareEngineNetworkAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeleteVmwareEngineNetworkRequest 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

getCluster

Retrieves a Cluster resource by its resource name.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetClusterRequest 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\VmwareEngine\V1\Cluster

getHcxActivationKey

Retrieves a HcxActivationKey resource by its resource name.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getHcxActivationKeyAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetHcxActivationKeyRequest 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\VmwareEngine\V1\HcxActivationKey

getNetworkPolicy

Retrieves a NetworkPolicy resource by its resource name.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getNetworkPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetNetworkPolicyRequest 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\VmwareEngine\V1\NetworkPolicy

getNodeType

Gets details of a single NodeType.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getNodeTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetNodeTypeRequest 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\VmwareEngine\V1\NodeType

getPrivateCloud

Retrieves a PrivateCloud resource by its resource name.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getPrivateCloudAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetPrivateCloudRequest 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\VmwareEngine\V1\PrivateCloud

getVmwareEngineNetwork

Retrieves a VmwareEngineNetwork resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING, ACTIVE, DELETING).

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getVmwareEngineNetworkAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetVmwareEngineNetworkRequest 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\VmwareEngine\V1\VmwareEngineNetwork

listClusters

Lists Cluster resources in a given private cloud.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listClustersAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListClustersRequest 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

listHcxActivationKeys

Lists HcxActivationKey resources in a given private cloud.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listHcxActivationKeysAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListHcxActivationKeysRequest 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

listNetworkPolicies

Lists NetworkPolicy resources in a specified project and location.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listNetworkPoliciesAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListNetworkPoliciesRequest 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

listNodeTypes

Lists node types

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listNodeTypesAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListNodeTypesRequest 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

listPrivateClouds

Lists PrivateCloud resources in a given project and location.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listPrivateCloudsAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListPrivateCloudsRequest 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

listSubnets

Lists subnets in a given private cloud.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listSubnetsAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListSubnetsRequest 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

listVmwareEngineNetworks

Lists VmwareEngineNetwork resources in a given project and location.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listVmwareEngineNetworksAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListVmwareEngineNetworksRequest 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

resetNsxCredentials

Resets credentials of the NSX appliance.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::resetNsxCredentialsAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ResetNsxCredentialsRequest 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

resetVcenterCredentials

Resets credentials of the Vcenter appliance.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::resetVcenterCredentialsAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ResetVcenterCredentialsRequest 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

showNsxCredentials

Gets details of credentials for NSX appliance.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::showNsxCredentialsAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ShowNsxCredentialsRequest 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\VmwareEngine\V1\Credentials

showVcenterCredentials

Gets details of credentials for Vcenter appliance.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::showVcenterCredentialsAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ShowVcenterCredentialsRequest 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\VmwareEngine\V1\Credentials

undeletePrivateCloud

Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::undeletePrivateCloudAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UndeletePrivateCloudRequest 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

updateCluster

Modifies a Cluster resource. Only the following fields can be updated: node_type_configs.*.node_count. Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::updateClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdateClusterRequest 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

updateNetworkPolicy

Modifies a NetworkPolicy resource. Only the following fields can be updated: internet_access, external_ip, edge_services_cidr.

Only fields specified in updateMask are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a NetworkService cannot be updated when NetworkService.state is set to RECONCILING.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::updateNetworkPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdateNetworkPolicyRequest 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

updatePrivateCloud

Modifies a PrivateCloud resource. Only the following fields can be updated: description.

Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::updatePrivateCloudAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdatePrivateCloudRequest 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

updateVmwareEngineNetwork

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::updateVmwareEngineNetworkAsync() .

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdateVmwareEngineNetworkRequest 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

getLocation

Gets information about a location.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getLocationAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest 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\Location\Location

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::listLocationsAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest 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

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest 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\Iam\V1\Policy

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest 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\Iam\V1\Policy

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\VmwareEngine\V1\Client\BaseClient\self::testIamPermissionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest 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\Iam\V1\TestIamPermissionsResponse

createClusterAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createHcxActivationKeyAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateHcxActivationKeyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createNetworkPolicyAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateNetworkPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createPrivateCloudAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreatePrivateCloudRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createVmwareEngineNetworkAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\CreateVmwareEngineNetworkRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteClusterAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeleteClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteNetworkPolicyAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeleteNetworkPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deletePrivateCloudAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeletePrivateCloudRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteVmwareEngineNetworkAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\DeleteVmwareEngineNetworkRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getClusterAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getHcxActivationKeyAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetHcxActivationKeyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getNetworkPolicyAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetNetworkPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getNodeTypeAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetNodeTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getPrivateCloudAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetPrivateCloudRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getVmwareEngineNetworkAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\GetVmwareEngineNetworkRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listClustersAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListClustersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listHcxActivationKeysAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListHcxActivationKeysRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listNetworkPoliciesAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListNetworkPoliciesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listNodeTypesAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListNodeTypesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listPrivateCloudsAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListPrivateCloudsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSubnetsAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListSubnetsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listVmwareEngineNetworksAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ListVmwareEngineNetworksRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

resetNsxCredentialsAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ResetNsxCredentialsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

resetVcenterCredentialsAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ResetVcenterCredentialsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

showNsxCredentialsAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ShowNsxCredentialsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

showVcenterCredentialsAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\ShowVcenterCredentialsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

undeletePrivateCloudAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UndeletePrivateCloudRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateClusterAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateNetworkPolicyAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdateNetworkPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updatePrivateCloudAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdatePrivateCloudRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateVmwareEngineNetworkAsync

Parameters
Name	Description
request	Google\Cloud\VmwareEngine\V1\UpdateVmwareEngineNetworkRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

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

static::clusterName

Formats a string containing the fully-qualified path to represent a cluster resource.

Parameters
Name	Description
project	string
location	string
privateCloud	string
cluster	string

Returns
Type	Description
string	The formatted cluster resource.

static::hcxActivationKeyName

Formats a string containing the fully-qualified path to represent a hcx_activation_key resource.

Parameters
Name	Description
project	string
location	string
privateCloud	string
hcxActivationKey	string

Returns
Type	Description
string	The formatted hcx_activation_key resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameters
Name	Description
project	string
network	string

Returns
Type	Description
string	The formatted network resource.

static::networkPolicyName

Formats a string containing the fully-qualified path to represent a network_policy resource.

Parameters
Name	Description
project	string
location	string
networkPolicy	string

Returns
Type	Description
string	The formatted network_policy resource.

static::nodeTypeName

Formats a string containing the fully-qualified path to represent a node_type resource.

Parameters
Name	Description
project	string
location	string
nodeType	string

Returns
Type	Description
string	The formatted node_type resource.

static::privateCloudName

Formats a string containing the fully-qualified path to represent a private_cloud resource.

Parameters
Name	Description
project	string
location	string
privateCloud	string

Returns
Type	Description
string	The formatted private_cloud resource.

static::vmwareEngineNetworkName

Formats a string containing the fully-qualified path to represent a vmware_engine_network resource.

Parameters
Name	Description
project	string
location	string
vmwareEngineNetwork	string

Returns
Type	Description
string	The formatted vmware_engine_network resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• cluster: projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}
• hcxActivationKey: projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key}
• location: projects/{project}/locations/{location}
• network: projects/{project}/global/networks/{network}
• networkPolicy: projects/{project}/locations/{location}/networkPolicies/{network_policy}
• nodeType: projects/{project}/locations/{location}/nodeTypes/{node_type}
• privateCloud: projects/{project}/locations/{location}/privateClouds/{private_cloud}
• vmwareEngineNetwork: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.