Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.VmwareClustersResource

The "vmwareClusters" collection of methods.

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

Constructors

VmwareClustersResource(IClientService)

Constructs a new resource.

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

Properties

Operations

Gets the Operations resource.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.OperationsResource Operations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.OperationsResource

VmwareNodePools

Gets the VmwareNodePools resource.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.VmwareNodePoolsResource VmwareNodePools { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.VmwareNodePoolsResource

Methods

Create(VmwareCluster, string)

Creates a new VMware user cluster in a given project and location.

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

The body of the request.

string parent

Required. The parent of the project and location where this cluster is created in. Format: "projects/{project}/locations/{location}"

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.CreateRequest

Delete(string)

Deletes a single VMware Cluster.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Name of the VMware user cluster to be deleted. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.DeleteRequest

Enroll(EnrollVmwareClusterRequest, string)

Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.EnrollRequest Enroll(EnrollVmwareClusterRequest body, string parent)
Parameters
Type Name Description
EnrollVmwareClusterRequest body

The body of the request.

string parent

Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/{project}/locations/{location}"

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.EnrollRequest

Get(string)

Gets details of a single VMware Cluster.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Name of the VMware user cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.GetRequest

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.VmwareClustersResource.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.VmwareClustersResource.GetIamPolicyRequest

List(string)

Lists VMware Clusters in a given project and location.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.ListRequest

Patch(VmwareCluster, string)

Updates the parameters of a single VMware cluster.

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

The body of the request.

string name

Immutable. The VMware user cluster resource name.

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.PatchRequest

QueryVersionConfig(string)

Queries the VMware user cluster version config.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.QueryVersionConfigRequest QueryVersionConfig(string parent)
Parameters
Type Name Description
string parent

Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.QueryVersionConfigRequest

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.VmwareClustersResource.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.VmwareClustersResource.SetIamPolicyRequest

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.VmwareClustersResource.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.VmwareClustersResource.TestIamPermissionsRequest

Unenroll(string)

Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.

Declaration
public virtual ProjectsResource.LocationsResource.VmwareClustersResource.UnenrollRequest Unenroll(string name)
Parameters
Type Name Description
string name

Required. Name of the VMware user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"

Returns
Type Description
ProjectsResource.LocationsResource.VmwareClustersResource.UnenrollRequest
In this article
Back to top Generated by DocFX