class ProjectsLocationsPrivateClouds extends Resource (View source)

The "privateClouds" collection of methods.

Typical usage is:

 $vmwareengineService = new Google\Service\VMwareEngine(...);
 $privateClouds = $vmwareengineService->projects_locations_privateClouds;

Methods

create(string $parent, PrivateCloud $postBody, array $optParams = [])

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

delete(string $name, array $optParams = [])

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. (privateClouds.delete)

get(string $name, array $optParams = [])

Retrieves a PrivateCloud resource by its resource name. (privateClouds.get)

getDnsForwarding(string $name, array $optParams = [])

Gets details of the DnsForwarding config. (privateClouds.getDnsForwarding)

getIamPolicy(string $resource, array $optParams = [])

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

listProjectsLocationsPrivateClouds(string $parent, array $optParams = [])

Lists PrivateCloud resources in a given project and location.

patch(string $name, PrivateCloud $postBody, array $optParams = [])

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. (privateClouds.patch)

resetNsxCredentials(string $privateCloud, ResetNsxCredentialsRequest $postBody, array $optParams = [])

Resets credentials of the NSX appliance. (privateClouds.resetNsxCredentials)

resetVcenterCredentials(string $privateCloud, ResetVcenterCredentialsRequest $postBody, array $optParams = [])

Resets credentials of the Vcenter appliance.

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (privateClouds.setIamPolicy)

showNsxCredentials(string $privateCloud, array $optParams = [])

Gets details of credentials for NSX appliance.

showVcenterCredentials(string $privateCloud, array $optParams = [])

Gets details of credentials for Vcenter appliance.

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

undelete(string $name, UndeletePrivateCloudRequest $postBody, array $optParams = [])

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. (privateClouds.undelete)

updateDnsForwarding(string $name, DnsForwarding $postBody, array $optParams = [])

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Details

Operation create(string $parent, PrivateCloud $postBody, array $optParams = [])

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

Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional. Creating a private cloud also creates a management cluster for that private cloud. (privateClouds.create)

Parameters

string $parent

Required. The resource name of the location to create the new private cloud in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a

PrivateCloud $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $name, array $optParams = [])

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. (privateClouds.delete)

Parameters

string $name

Required. The resource name of the private cloud to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

PrivateCloud get(string $name, array $optParams = [])

Retrieves a PrivateCloud resource by its resource name. (privateClouds.get)

Parameters

string $name

Required. The resource name of the private cloud to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

array $optParams

Optional parameters.

Return Value

PrivateCloud

Exceptions

Exception

DnsForwarding getDnsForwarding(string $name, array $optParams = [])

Gets details of the DnsForwarding config. (privateClouds.getDnsForwarding)

Parameters

string $name

Required. The resource name of a DnsForwarding to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my- cloud/dnsForwarding

array $optParams

Optional parameters.

Return Value

DnsForwarding

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

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

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListPrivateCloudsResponse listProjectsLocationsPrivateClouds(string $parent, array $optParams = [])

Lists PrivateCloud resources in a given project and location.

(privateClouds.listProjectsLocationsPrivateClouds)

Parameters

string $parent

Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a

array $optParams

Optional parameters.

Return Value

ListPrivateCloudsResponse

Exceptions

Exception

Operation patch(string $name, PrivateCloud $postBody, array $optParams = [])

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. (privateClouds.patch)

Parameters

string $name

Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

PrivateCloud $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation resetNsxCredentials(string $privateCloud, ResetNsxCredentialsRequest $postBody, array $optParams = [])

Resets credentials of the NSX appliance. (privateClouds.resetNsxCredentials)

Parameters

string $privateCloud

Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

ResetNsxCredentialsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation resetVcenterCredentials(string $privateCloud, ResetVcenterCredentialsRequest $postBody, array $optParams = [])

Resets credentials of the Vcenter appliance.

(privateClouds.resetVcenterCredentials)

Parameters

string $privateCloud

Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

ResetVcenterCredentialsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (privateClouds.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Credentials showNsxCredentials(string $privateCloud, array $optParams = [])

Gets details of credentials for NSX appliance.

(privateClouds.showNsxCredentials)

Parameters

string $privateCloud

Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

array $optParams

Optional parameters.

Return Value

Credentials

Exceptions

Exception

Credentials showVcenterCredentials(string $privateCloud, array $optParams = [])

Gets details of credentials for Vcenter appliance.

(privateClouds.showVcenterCredentials)

Parameters

string $privateCloud

Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

array $optParams

Optional parameters.

Return Value

Credentials

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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. (privateClouds.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception

Operation undelete(string $name, UndeletePrivateCloudRequest $postBody, array $optParams = [])

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. (privateClouds.undelete)

Parameters

string $name

Required. The resource name of the private cloud scheduled for deletion. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

UndeletePrivateCloudRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation updateDnsForwarding(string $name, DnsForwarding $postBody, array $optParams = [])

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

(privateClouds.updateDnsForwarding)

Parameters

string $name

Output only. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my- cloud/dnsForwarding

DnsForwarding $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception