All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

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

    





Dataproc.Projects.Regions.Clusters.Patch (Cloud Dataproc API v1-rev20240605-2.0.0)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.dataproc
    

    Class Dataproc.Projects.Regions.Clusters.Patch
    

    

    


    


    

    


    

    

      

    • 


        

      • 



        Constructor Detail
        




          

        • 

          Patch
          

          protected Patch(String projectId,
                String region,
                String clusterName,
                Cluster content)
          

          Updates a cluster in a project. The returned Operation.metadata will be
 ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dat
 aproc.v1#clusteroperationmetadata). 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 the dataproc server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
 
           Dataproc.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
 be called to initialize this instance immediately after invoking the constructor. 
          

          

          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
          

          Since:
          

          1.13
          

          

          • 

        

        • 

      


        

      • 



        Method Detail
        
















































          

        • 

          getProjectId
          

          public String getProjectId()
          

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

          • 

        








          

        • 

          getRegion
          

          public String getRegion()
          

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

          • 

        








          

        • 

          getClusterName
          

          public String getClusterName()
          

          Required. The cluster name.
          

          • 

        








          

        • 

          getGracefulDecommissionTimeout
          

          public String getGracefulDecommissionTimeout()
          

          Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows removing nodes
         from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs
         in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default
         timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON
         representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only
         supported on Dataproc image versions 1.2 and higher.
          

          • 

        




          

        • 

          setGracefulDecommissionTimeout
          

          public Dataproc.Projects.Regions.Clusters.Patch setGracefulDecommissionTimeout(String gracefulDecommissionTimeout)
          

          Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows
 removing nodes from the cluster without interrupting jobs in progress. Timeout
 specifies how long to wait for jobs in progress to finish before forcefully removing
 nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful
 decommission), and the maximum allowed timeout is 1 day. (see JSON representation of
 Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only
 supported on Dataproc image versions 1.2 and higher.
          

          • 

        




          

        • 

          getRequestId
          

          public String getRequestId()
          

          Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequest
         (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.datapro
         c.v1.UpdateClusterRequest)s with the same id, then the second request will be ignored and the first
         google.longrunning.Operation created and stored in the backend is returned.It is recommended to
         always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The
         ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
         maximum length is 40 characters.
          

          • 

        




          

        • 

          setRequestId
          

          public Dataproc.Projects.Regions.Clusters.Patch setRequestId(String requestId)
          

          Optional. A unique ID used to identify the request. If the server receives two
 UpdateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud
 .dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s with the same id, then the
 second request will be ignored and the first google.longrunning.Operation created and
 stored in the backend is returned.It is recommended to always set this value to a UUID
 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only
 letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length
 is 40 characters.
          

          • 

        




          

        • 

          getUpdateMask
          

          public String getUpdateMask()
          

          Required. Specifies the path, relative to Cluster, of the field to update. For example, to change
         the number of workers in a cluster to 5, the update_mask parameter would be specified as
         config.worker_config.num_instances, and the PATCH request body would specify the new value, as
         follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of
         preemptible workers in a cluster to 5, the update_mask parameter would be
         config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: {
         "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } *Note:* Currently, only the following
         fields can be updated: *Mask* *Purpose* *labels* Update labels *config.worker_config.num_instances*
         Resize primary worker group *config.secondary_worker_config.num_instances* Resize secondary worker
         group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies
          

          • 

        




          

        • 

          setUpdateMask
          

          public Dataproc.Projects.Regions.Clusters.Patch setUpdateMask(String updateMask)
          

          Required. Specifies the path, relative to Cluster, of the field to update. For example,
 to change the number of workers in a cluster to 5, the update_mask parameter would be
 specified as config.worker_config.num_instances, and the PATCH request body would
 specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } }
 } Similarly, to change the number of preemptible workers in a cluster to 5, the
 update_mask parameter would be config.secondary_worker_config.num_instances, and the
 PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{
 "numInstances":"5" } } } *Note:* Currently, only the following fields can be updated:
 *Mask* *Purpose* *labels* Update labels *config.worker_config.num_instances* Resize
 primary worker group *config.secondary_worker_config.num_instances* Resize secondary
 worker group config.autoscaling_config.policy_uri Use, stop using, or change
 autoscaling policies
          

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2024 Google. All rights reserved.




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy