ProjectsLocationsPrivateClouds
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
Creates a new PrivateCloud
resource in a given project and location.
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)
Retrieves a PrivateCloud
resource by its resource name. (privateClouds.get)
Gets details of the DnsForwarding
config. (privateClouds.getDnsForwarding)
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)
Lists PrivateCloud
resources in a given project and location.
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)
Resets credentials of the NSX appliance. (privateClouds.resetNsxCredentials)
Resets credentials of the Vcenter appliance.
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)
Gets details of credentials for NSX appliance.
Gets details of credentials for Vcenter appliance.
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.
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)
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)
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)
PrivateCloud
get(string $name, array $optParams = [])
Retrieves a PrivateCloud
resource by its resource name. (privateClouds.get)
DnsForwarding
getDnsForwarding(string $name, array $optParams = [])
Gets details of the DnsForwarding
config. (privateClouds.getDnsForwarding)
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)
ListPrivateCloudsResponse
listProjectsLocationsPrivateClouds(string $parent, array $optParams = [])
Lists PrivateCloud
resources in a given project and location.
(privateClouds.listProjectsLocationsPrivateClouds)
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)
Operation
resetNsxCredentials(string $privateCloud, ResetNsxCredentialsRequest $postBody, array $optParams = [])
Resets credentials of the NSX appliance. (privateClouds.resetNsxCredentials)
Operation
resetVcenterCredentials(string $privateCloud, ResetVcenterCredentialsRequest $postBody, array $optParams = [])
Resets credentials of the Vcenter appliance.
(privateClouds.resetVcenterCredentials)
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)
Credentials
showNsxCredentials(string $privateCloud, array $optParams = [])
Gets details of credentials for NSX appliance.
(privateClouds.showNsxCredentials)
Credentials
showVcenterCredentials(string $privateCloud, array $optParams = [])
Gets details of credentials for Vcenter appliance.
(privateClouds.showVcenterCredentials)
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)
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)
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)