Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.PrivateCloudsResource

The "privateClouds" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.PrivateCloudsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.VMwareEngine.v1
Assembly: Google.Apis.VMwareEngine.v1.dll
Syntax
public class ProjectsResource.LocationsResource.PrivateCloudsResource

Constructors

PrivateCloudsResource(IClientService)

Constructs a new resource.

Declaration
public PrivateCloudsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Clusters

Gets the Clusters resource.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ClustersResource Clusters { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ClustersResource

ExternalAddresses

Gets the ExternalAddresses resource.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ExternalAddressesResource ExternalAddresses { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ExternalAddressesResource

HcxActivationKeys

Gets the HcxActivationKeys resource.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.HcxActivationKeysResource HcxActivationKeys { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.HcxActivationKeysResource

LoggingServers

Gets the LoggingServers resource.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.LoggingServersResource LoggingServers { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.LoggingServersResource

ManagementDnsZoneBindings

Gets the ManagementDnsZoneBindings resource.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ManagementDnsZoneBindingsResource ManagementDnsZoneBindings { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ManagementDnsZoneBindingsResource

Subnets

Gets the Subnets resource.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.SubnetsResource Subnets { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.SubnetsResource

Upgrades

Gets the Upgrades resource.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.UpgradesResource Upgrades { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.UpgradesResource

Methods

Create(PrivateCloud, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.CreateRequest Create(PrivateCloud body, string parent)
Parameters
Type Name Description
PrivateCloud body

The body of the request.

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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.CreateRequest

Delete(string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.DeleteRequest

Get(string)

Retrieves a PrivateCloud resource by its resource name.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.GetRequest Get(string name)
Parameters
Type Name Description
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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.GetRequest

GetDnsForwarding(string)

Gets details of the DnsForwarding config.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.GetDnsForwardingRequest GetDnsForwarding(string name)
Parameters
Type Name Description
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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.GetDnsForwardingRequest

GetIamPolicy(string)

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

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.GetIamPolicyRequest

List(string)

Lists PrivateCloud resources in a given project and location.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ListRequest List(string parent)
Parameters
Type Name Description
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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ListRequest

Patch(PrivateCloud, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.PatchRequest Patch(PrivateCloud body, string name)
Parameters
Type Name Description
PrivateCloud body

The body of the request.

string name

Output only. Identifier. 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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.PatchRequest

ResetNsxCredentials(ResetNsxCredentialsRequest, string)

Resets credentials of the NSX appliance.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ResetNsxCredentialsRequest ResetNsxCredentials(ResetNsxCredentialsRequest body, string privateCloud)
Parameters
Type Name Description
ResetNsxCredentialsRequest body

The body of the request.

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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ResetNsxCredentialsRequest

ResetVcenterCredentials(ResetVcenterCredentialsRequest, string)

Resets credentials of the Vcenter appliance.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ResetVcenterCredentialsRequest ResetVcenterCredentials(ResetVcenterCredentialsRequest body, string privateCloud)
Parameters
Type Name Description
ResetVcenterCredentialsRequest body

The body of the request.

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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ResetVcenterCredentialsRequest

SetIamPolicy(SetIamPolicyRequest, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.SetIamPolicyRequest

ShowNsxCredentials(string)

Gets details of credentials for NSX appliance.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ShowNsxCredentialsRequest ShowNsxCredentials(string privateCloud)
Parameters
Type Name Description
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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ShowNsxCredentialsRequest

ShowVcenterCredentials(string)

Gets details of credentials for Vcenter appliance.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.ShowVcenterCredentialsRequest ShowVcenterCredentials(string privateCloud)
Parameters
Type Name Description
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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.ShowVcenterCredentialsRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.TestIamPermissionsRequest

Undelete(UndeletePrivateCloudRequest, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.UndeleteRequest Undelete(UndeletePrivateCloudRequest body, string name)
Parameters
Type Name Description
UndeletePrivateCloudRequest body

The body of the request.

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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.UndeleteRequest

UpdateDnsForwarding(DnsForwarding, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.PrivateCloudsResource.UpdateDnsForwardingRequest UpdateDnsForwarding(DnsForwarding body, string name)
Parameters
Type Name Description
DnsForwarding body

The body of the request.

string name

Output only. Identifier. 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

Returns
Type Description
ProjectsResource.LocationsResource.PrivateCloudsResource.UpdateDnsForwardingRequest
In this article
Back to top Generated by DocFX