Class ProjectsResource.LocationsResource.BareMetalClustersResource

The "bareMetalClusters" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.BareMetalClustersResource

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.BareMetalClustersResource

Constructors

BareMetalClustersResource(IClientService)

Constructs a new resource.

Declaration

public BareMetalClustersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

BareMetalNodePools

Gets the BareMetalNodePools resource.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.BareMetalNodePoolsResource BareMetalNodePools { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.BareMetalClustersResource.BareMetalNodePoolsResource

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.BareMetalClustersResource.OperationsResource

Methods

Create(BareMetalCluster, string)

Creates a new bare metal cluster in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.CreateRequest Create(BareMetalCluster body, string parent)

Parameters

Type	Name	Description
BareMetalCluster	body	The body of the request.
string	parent	Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalClustersResource.CreateRequest

Delete(string)

Deletes a single bare metal Cluster.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. Name of the bare metal user cluster to be deleted. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalClustersResource.DeleteRequest

Enroll(EnrollBareMetalClusterRequest, string)

Enrolls an existing bare metal 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.BareMetalClustersResource.EnrollRequest Enroll(EnrollBareMetalClusterRequest body, string parent)

Parameters

Type	Name	Description
EnrollBareMetalClusterRequest	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.BareMetalClustersResource.EnrollRequest

Get(string)

Gets details of a single bare metal Cluster.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalClustersResource.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.BareMetalClustersResource.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.BareMetalClustersResource.GetIamPolicyRequest

List(string)

Lists bare metal clusters in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.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.BareMetalClustersResource.ListRequest

Patch(BareMetalCluster, string)

Updates the parameters of a single bare metal Cluster.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.PatchRequest Patch(BareMetalCluster body, string name)

Parameters

Type	Name	Description
BareMetalCluster	body	The body of the request.
string	name	Immutable. The bare metal user cluster resource name.

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalClustersResource.PatchRequest

QueryVersionConfig(string)

Queries the bare metal user cluster version config.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.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.BareMetalClustersResource.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.BareMetalClustersResource.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.BareMetalClustersResource.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.BareMetalClustersResource.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.BareMetalClustersResource.TestIamPermissionsRequest

Unenroll(string)

Unenrolls an existing bare metal 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 its clients.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalClustersResource.UnenrollRequest Unenroll(string name)

Parameters

Type	Name	Description
string	name	Required. Name of the bare metal user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalClusters/{cluster}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalClustersResource.UnenrollRequest