target.apidocs.com.google.api.services.vmwareengine.v1.VMwareEngine.Projects.Locations.PrivateClouds.html Maven / Gradle / Ivy
VMwareEngine.Projects.Locations.PrivateClouds (VMware Engine API v1-rev20240412-2.0.0)
com.google.api.services.vmwareengine.v1
Class VMwareEngine.Projects.Locations.PrivateClouds
- java.lang.Object
-
- com.google.api.services.vmwareengine.v1.VMwareEngine.Projects.Locations.PrivateClouds
-
- Enclosing class:
- VMwareEngine.Projects.Locations
public class VMwareEngine.Projects.Locations.PrivateClouds
extends Object
The "privateClouds" collection of methods.
-
-
Nested Class Summary
-
Constructor Summary
Constructors
Constructor and Description
PrivateClouds()
-
Method Summary
-
-
Method Detail
-
create
public VMwareEngine.Projects.Locations.PrivateClouds.Create create(String parent,
PrivateCloud content)
throws IOException
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](https://cloud.google.com/vmware-
engine/docs/concepts-vmware-components) for that private cloud.
Create a request for the method "privateClouds.create".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`content - the PrivateCloud- Returns:
- the request
- Throws:
IOException
-
delete
public VMwareEngine.Projects.Locations.PrivateClouds.Delete delete(String name)
throws IOException
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.
Create a request for the method "privateClouds.delete".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`- Returns:
- the request
- Throws:
IOException
-
get
public VMwareEngine.Projects.Locations.PrivateClouds.Get get(String name)
throws IOException
Retrieves a `PrivateCloud` resource by its resource name.
Create a request for the method "privateClouds.get".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`- Returns:
- the request
- Throws:
IOException
-
getDnsForwarding
public VMwareEngine.Projects.Locations.PrivateClouds.GetDnsForwarding getDnsForwarding(String name)
throws IOException
Gets details of the `DnsForwarding` config.
Create a request for the method "privateClouds.getDnsForwarding".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`- Returns:
- the request
- Throws:
IOException
-
getIamPolicy
public VMwareEngine.Projects.Locations.PrivateClouds.GetIamPolicy getIamPolicy(String resource)
throws IOException
Gets the access control policy for a resource. Returns an empty policy if the resource exists and
does not have a policy set.
Create a request for the method "privateClouds.getIamPolicy".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
resource - REQUIRED: The resource for which the policy is being requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
this field.- Returns:
- the request
- Throws:
IOException
-
list
public VMwareEngine.Projects.Locations.PrivateClouds.List list(String parent)
throws IOException
Lists `PrivateCloud` resources in a given project and location.
Create a request for the method "privateClouds.list".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`- Returns:
- the request
- Throws:
IOException
-
patch
public VMwareEngine.Projects.Locations.PrivateClouds.Patch patch(String name,
PrivateCloud content)
throws IOException
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.
Create a request for the method "privateClouds.patch".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`content - the PrivateCloud- Returns:
- the request
- Throws:
IOException
-
resetNsxCredentials
public VMwareEngine.Projects.Locations.PrivateClouds.ResetNsxCredentials resetNsxCredentials(String privateCloud,
ResetNsxCredentialsRequest content)
throws IOException
Resets credentials of the NSX appliance.
Create a request for the method "privateClouds.resetNsxCredentials".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`content - the ResetNsxCredentialsRequest- Returns:
- the request
- Throws:
IOException
-
resetVcenterCredentials
public VMwareEngine.Projects.Locations.PrivateClouds.ResetVcenterCredentials resetVcenterCredentials(String privateCloud,
ResetVcenterCredentialsRequest content)
throws IOException
Resets credentials of the Vcenter appliance.
Create a request for the method "privateClouds.resetVcenterCredentials".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation.
- Parameters:
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`content - the ResetVcenterCredentialsRequest- Returns:
- the request
- Throws:
IOException
-
setIamPolicy
public VMwareEngine.Projects.Locations.PrivateClouds.SetIamPolicy setIamPolicy(String resource,
SetIamPolicyRequest content)
throws IOException
Sets the access control policy on the specified resource. Replaces any existing policy. Can
return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Create a request for the method "privateClouds.setIamPolicy".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
resource - REQUIRED: The resource for which the policy is being specified. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
this field.content - the SetIamPolicyRequest- Returns:
- the request
- Throws:
IOException
-
showNsxCredentials
public VMwareEngine.Projects.Locations.PrivateClouds.ShowNsxCredentials showNsxCredentials(String privateCloud)
throws IOException
Gets details of credentials for NSX appliance.
Create a request for the method "privateClouds.showNsxCredentials".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`- Returns:
- the request
- Throws:
IOException
-
showVcenterCredentials
public VMwareEngine.Projects.Locations.PrivateClouds.ShowVcenterCredentials showVcenterCredentials(String privateCloud)
throws IOException
Gets details of credentials for Vcenter appliance.
Create a request for the method "privateClouds.showVcenterCredentials".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation.
- Parameters:
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`- Returns:
- the request
- Throws:
IOException
-
testIamPermissions
public VMwareEngine.Projects.Locations.PrivateClouds.TestIamPermissions testIamPermissions(String resource,
TestIamPermissionsRequest content)
throws IOException
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.
Create a request for the method "privateClouds.testIamPermissions".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
this field.content - the TestIamPermissionsRequest- Returns:
- the request
- Throws:
IOException
-
undelete
public VMwareEngine.Projects.Locations.PrivateClouds.Undelete undelete(String name,
UndeletePrivateCloudRequest content)
throws IOException
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.
Create a request for the method "privateClouds.undelete".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`content - the UndeletePrivateCloudRequest- Returns:
- the request
- Throws:
IOException
-
updateDnsForwarding
public VMwareEngine.Projects.Locations.PrivateClouds.UpdateDnsForwarding updateDnsForwarding(String name,
DnsForwarding content)
throws IOException
Updates the parameters of the `DnsForwarding` config, like associated domains. Only fields
specified in `update_mask` are applied.
Create a request for the method "privateClouds.updateDnsForwarding".
This request holds the parameters needed by the vmwareengine server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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`content - the DnsForwarding- Returns:
- the request
- Throws:
IOException
-
clusters
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters clusters()
An accessor for creating requests from the Clusters collection.
The typical use is:
VMwareEngine vmwareengine = new VMwareEngine(...);
VMwareEngine.Clusters.List request = vmwareengine.clusters().list(parameters ...)
- Returns:
- the resource collection
-
externalAddresses
public VMwareEngine.Projects.Locations.PrivateClouds.ExternalAddresses externalAddresses()
An accessor for creating requests from the ExternalAddresses collection.
The typical use is:
VMwareEngine vmwareengine = new VMwareEngine(...);
VMwareEngine.ExternalAddresses.List request = vmwareengine.externalAddresses().list(parameters ...)
- Returns:
- the resource collection
-
hcxActivationKeys
public VMwareEngine.Projects.Locations.PrivateClouds.HcxActivationKeys hcxActivationKeys()
An accessor for creating requests from the HcxActivationKeys collection.
The typical use is:
VMwareEngine vmwareengine = new VMwareEngine(...);
VMwareEngine.HcxActivationKeys.List request = vmwareengine.hcxActivationKeys().list(parameters ...)
- Returns:
- the resource collection
-
loggingServers
public VMwareEngine.Projects.Locations.PrivateClouds.LoggingServers loggingServers()
An accessor for creating requests from the LoggingServers collection.
The typical use is:
VMwareEngine vmwareengine = new VMwareEngine(...);
VMwareEngine.LoggingServers.List request = vmwareengine.loggingServers().list(parameters ...)
- Returns:
- the resource collection
-
managementDnsZoneBindings
public VMwareEngine.Projects.Locations.PrivateClouds.ManagementDnsZoneBindings managementDnsZoneBindings()
An accessor for creating requests from the ManagementDnsZoneBindings collection.
The typical use is:
VMwareEngine vmwareengine = new VMwareEngine(...);
VMwareEngine.ManagementDnsZoneBindings.List request = vmwareengine.managementDnsZoneBindings().list(parameters ...)
- Returns:
- the resource collection
-
subnets
public VMwareEngine.Projects.Locations.PrivateClouds.Subnets subnets()
An accessor for creating requests from the Subnets collection.
The typical use is:
VMwareEngine vmwareengine = new VMwareEngine(...);
VMwareEngine.Subnets.List request = vmwareengine.subnets().list(parameters ...)
- Returns:
- the resource collection
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy