Show / Hide Table of Contents

Class ProjectsResource.RegionsResource.ClustersResource

The "clusters" collection of methods.

Inheritance
System.Object
ProjectsResource.RegionsResource.ClustersResource
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Dataproc.v1beta2
Assembly: Google.Apis.Dataproc.v1beta2.dll
Syntax
public class ClustersResource

Constructors

ClustersResource(IClientService)

Constructs a new resource.

Declaration
public ClustersResource(IClientService service)
Parameters
Type Name Description
Google.Apis.Services.IClientService service

Methods

Create(Cluster, String, String)

Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.CreateRequest Create(Cluster body, string projectId, string region)
Parameters
Type Name Description
Cluster body

The body of the request.

System.String projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.CreateRequest

Delete(String, String, String)

Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.DeleteRequest Delete(string projectId, string region, string clusterName)
Parameters
Type Name Description
System.String projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

System.String clusterName

Required. The cluster name.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.DeleteRequest

Diagnose(DiagnoseClusterRequest, String, String, String)

Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata). After the operation completes, Operation.response contains Empty.

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.DiagnoseRequest Diagnose(DiagnoseClusterRequest body, string projectId, string region, string clusterName)
Parameters
Type Name Description
DiagnoseClusterRequest body

The body of the request.

System.String projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

System.String clusterName

Required. The cluster name.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.DiagnoseRequest

Get(String, String, String)

Gets the resource representation for a cluster in a project.

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.GetRequest Get(string projectId, string region, string clusterName)
Parameters
Type Name Description
System.String projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

System.String clusterName

Required. The cluster name.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.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.RegionsResource.ClustersResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
System.String resource

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

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.GetIamPolicyRequest

InjectCredentials(InjectCredentialsRequest, String, String, String)

Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC.

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.InjectCredentialsRequest InjectCredentials(InjectCredentialsRequest body, string project, string region, string cluster)
Parameters
Type Name Description
InjectCredentialsRequest body

The body of the request.

System.String project

Required. The ID of the Google Cloud Platform project the cluster belongs to, of the form projects/.

System.String region

Required. The region containing the cluster, of the form regions/.

System.String cluster

Required. The cluster, in the form clusters/.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.InjectCredentialsRequest

List(String, String)

Lists all regions/{region}/clusters in a project alphabetically.

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.ListRequest List(string projectId, string region)
Parameters
Type Name Description
System.String projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.ListRequest

Patch(Cluster, String, String, String)

Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned.

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.PatchRequest Patch(Cluster body, string projectId, string region, string clusterName)
Parameters
Type Name Description
Cluster body

The body of the request.

System.String projectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

System.String clusterName

Required. The cluster name.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.PatchRequest

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.RegionsResource.ClustersResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

System.String resource

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

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.SetIamPolicyRequest

Start(StartClusterRequest, String, String, String)

Starts a cluster in a project.

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.StartRequest Start(StartClusterRequest body, string projectId, string region, string clusterName)
Parameters
Type Name Description
StartClusterRequest body

The body of the request.

System.String projectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

System.String clusterName

Required. The cluster name.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.StartRequest

Stop(StopClusterRequest, String, String, String)

Stops a cluster in a project.

Declaration
public virtual ProjectsResource.RegionsResource.ClustersResource.StopRequest Stop(StopClusterRequest body, string projectId, string region, string clusterName)
Parameters
Type Name Description
StopClusterRequest body

The body of the request.

System.String projectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

System.String region

Required. The Dataproc region in which to handle the request.

System.String clusterName

Required. The cluster name.

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.StopRequest

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.RegionsResource.ClustersResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

System.String resource

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

Returns
Type Description
ProjectsResource.RegionsResource.ClustersResource.TestIamPermissionsRequest
In This Article
Back to top