• Home
• com.google.apis
• google-api-services-dataproc
• v1-rev20241025-2.0.0
• source code
• Dataproc.Projects.Regions.Clusters.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.dataproc.Dataproc.Projects.Regions.Clusters.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataproc
Class Dataproc.Projects.Regions.Clusters



java.lang.Object


com.google.api.services.dataproc.Dataproc.Projects.Regions.Clusters







Enclosing class:
Dataproc.Projects.Regions




public class Dataproc.Projects.Regions.Clusters
extends Object
The "clusters" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Dataproc.Projects.Regions.Clusters.Create 


class 
Dataproc.Projects.Regions.Clusters.Delete 


class 
Dataproc.Projects.Regions.Clusters.Diagnose 


class 
Dataproc.Projects.Regions.Clusters.Get 


class 
Dataproc.Projects.Regions.Clusters.GetIamPolicy 


class 
Dataproc.Projects.Regions.Clusters.InjectCredentials 


class 
Dataproc.Projects.Regions.Clusters.List 


class 
Dataproc.Projects.Regions.Clusters.NodeGroups
The "nodeGroups" collection of methods.



class 
Dataproc.Projects.Regions.Clusters.Patch 


class 
Dataproc.Projects.Regions.Clusters.Repair 


class 
Dataproc.Projects.Regions.Clusters.SetIamPolicy 


class 
Dataproc.Projects.Regions.Clusters.Start 


class 
Dataproc.Projects.Regions.Clusters.Stop 


class 
Dataproc.Projects.Regions.Clusters.TestIamPermissions 









Constructor Summary

Constructors 

Constructor and Description


Clusters() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Dataproc.Projects.Regions.Clusters.Create
create(String projectId,
      String region,
      Cluster content)
Creates a cluster in a project.



Dataproc.Projects.Regions.Clusters.Delete
delete(String projectId,
      String region,
      String clusterName)
Deletes a cluster in a project.



Dataproc.Projects.Regions.Clusters.Diagnose
diagnose(String projectId,
        String region,
        String clusterName,
        DiagnoseClusterRequest content)
Gets cluster diagnostic information.



Dataproc.Projects.Regions.Clusters.Get
get(String projectId,
   String region,
   String clusterName)
Gets the resource representation for a cluster in a project.



Dataproc.Projects.Regions.Clusters.GetIamPolicy
getIamPolicy(String resource,
            GetIamPolicyRequest content)
Gets the access control policy for a resource.



Dataproc.Projects.Regions.Clusters.InjectCredentials
injectCredentials(String project,
                 String region,
                 String cluster,
                 InjectCredentialsRequest content)
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.



Dataproc.Projects.Regions.Clusters.List
list(String projectId,
    String region)
Lists all regions/{region}/clusters in a project alphabetically.



Dataproc.Projects.Regions.Clusters.NodeGroups
nodeGroups()
An accessor for creating requests from the NodeGroups collection.



Dataproc.Projects.Regions.Clusters.Patch
patch(String projectId,
     String region,
     String clusterName,
     Cluster content)
Updates a cluster in a project.



Dataproc.Projects.Regions.Clusters.Repair
repair(String projectId,
      String region,
      String clusterName,
      RepairClusterRequest content)
Repairs a cluster.



Dataproc.Projects.Regions.Clusters.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on the specified resource.



Dataproc.Projects.Regions.Clusters.Start
start(String projectId,
     String region,
     String clusterName,
     StartClusterRequest content)
Starts a cluster in a project.



Dataproc.Projects.Regions.Clusters.Stop
stop(String projectId,
    String region,
    String clusterName,
    StopClusterRequest content)
Stops a cluster in a project.



Dataproc.Projects.Regions.Clusters.TestIamPermissions
testIamPermissions(String resource,
                  TestIamPermissionsRequest content)
Returns permissions that a caller has on the specified resource.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Clusters
public Clusters()









Method Detail





create
public Dataproc.Projects.Regions.Clusters.Create create(String projectId,
                                                        String region,
                                                        Cluster content)
                                                 throws IOException
Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata
 (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationme
 tadata).

 Create a request for the method "clusters.create".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
content - the Cluster
Returns:
the request
Throws:
IOException








delete
public Dataproc.Projects.Regions.Clusters.Delete delete(String projectId,
                                                        String region,
                                                        String clusterName)
                                                 throws IOException
Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata
 (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationme
 tadata).

 Create a request for the method "clusters.delete".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
clusterName - Required. The cluster name.
Returns:
the request
Throws:
IOException








diagnose
public Dataproc.Projects.Regions.Clusters.Diagnose diagnose(String projectId,
                                                            String region,
                                                            String clusterName,
                                                            DiagnoseClusterRequest content)
                                                     throws IOException
Gets cluster diagnostic information. The returned Operation.metadata will be
 ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.datap
 roc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains
 DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.datapro
 c.v1#diagnoseclusterresults).

 Create a request for the method "clusters.diagnose".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
clusterName - Required. The cluster name.
content - the DiagnoseClusterRequest
Returns:
the request
Throws:
IOException








get
public Dataproc.Projects.Regions.Clusters.Get get(String projectId,
                                                  String region,
                                                  String clusterName)
                                           throws IOException
Gets the resource representation for a cluster in a project.

 Create a request for the method "clusters.get".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
clusterName - Required. The cluster name.
Returns:
the request
Throws:
IOException








getIamPolicy
public Dataproc.Projects.Regions.Clusters.GetIamPolicy getIamPolicy(String resource,
                                                                    GetIamPolicyRequest content)
                                                             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 "clusters.getIamPolicy".

 This request holds the parameters needed by the dataproc 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.
content - the GetIamPolicyRequest
Returns:
the request
Throws:
IOException








injectCredentials
public Dataproc.Projects.Regions.Clusters.InjectCredentials injectCredentials(String project,
                                                                              String region,
                                                                              String cluster,
                                                                              InjectCredentialsRequest content)
                                                                       throws IOException
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.

 Create a request for the method "clusters.injectCredentials".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Required. The ID of the Google Cloud Platform project the cluster belongs to, of the form projects/.
region - Required. The region containing the cluster, of the form regions/.
cluster - Required. The cluster, in the form clusters/.
content - the InjectCredentialsRequest
Returns:
the request
Throws:
IOException








list
public Dataproc.Projects.Regions.Clusters.List list(String projectId,
                                                    String region)
                                             throws IOException
Lists all regions/{region}/clusters in a project alphabetically.

 Create a request for the method "clusters.list".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
Returns:
the request
Throws:
IOException








patch
public Dataproc.Projects.Regions.Clusters.Patch patch(String projectId,
                                                      String region,
                                                      String clusterName,
                                                      Cluster content)
                                               throws IOException
Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata
 (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationme
 tadata). The cluster must be in a RUNNING state or an error is returned.

 Create a request for the method "clusters.patch".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
clusterName - Required. The cluster name.
content - the Cluster
Returns:
the request
Throws:
IOException








repair
public Dataproc.Projects.Regions.Clusters.Repair repair(String projectId,
                                                        String region,
                                                        String clusterName,
                                                        RepairClusterRequest content)
                                                 throws IOException
Repairs a cluster.

 Create a request for the method "clusters.repair".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
clusterName - Required. The cluster name.
content - the RepairClusterRequest
Returns:
the request
Throws:
IOException








setIamPolicy
public Dataproc.Projects.Regions.Clusters.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 "clusters.setIamPolicy".

 This request holds the parameters needed by the dataproc 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








start
public Dataproc.Projects.Regions.Clusters.Start start(String projectId,
                                                      String region,
                                                      String clusterName,
                                                      StartClusterRequest content)
                                               throws IOException
Starts a cluster in a project.

 Create a request for the method "clusters.start".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
clusterName - Required. The cluster name.
content - the StartClusterRequest
Returns:
the request
Throws:
IOException








stop
public Dataproc.Projects.Regions.Clusters.Stop stop(String projectId,
                                                    String region,
                                                    String clusterName,
                                                    StopClusterRequest content)
                                             throws IOException
Stops a cluster in a project.

 Create a request for the method "clusters.stop".

 This request holds the parameters needed by the dataproc server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. The ID of the Google Cloud Platform project the cluster belongs to.
region - Required. The Dataproc region in which to handle the request.
clusterName - Required. The cluster name.
content - the StopClusterRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public Dataproc.Projects.Regions.Clusters.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 "clusters.testIamPermissions".

 This request holds the parameters needed by the dataproc 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








nodeGroups
public Dataproc.Projects.Regions.Clusters.NodeGroups nodeGroups()
An accessor for creating requests from the NodeGroups collection.

 
The typical use is:
 
    Dataproc dataproc = new Dataproc(...);
    Dataproc.NodeGroups.List request = dataproc.nodeGroups().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.