Cloud Dataproc API - Module Google::Cloud::Dataproc (v2.6.1)

Reference documentation and code samples for the Cloud Dataproc API module Google::Cloud::Dataproc.

Methods

.autoscaling_policy_service

def self.autoscaling_policy_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for AutoscalingPolicyService.

By default, this returns an instance of Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the AutoscalingPolicyService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About AutoscalingPolicyService

The API interface for managing autoscaling policies in the Dataproc API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.batch_controller

def self.batch_controller(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for BatchController.

By default, this returns an instance of Google::Cloud::Dataproc::V1::BatchController::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the BatchController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About BatchController

The BatchController provides methods to manage batch workloads.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.cluster_controller

def self.cluster_controller(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ClusterController.

By default, this returns an instance of Google::Cloud::Dataproc::V1::ClusterController::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ClusterController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ClusterController

The ClusterControllerService provides methods to manage clusters of Compute Engine instances.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-dataproc library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.dataproc)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.job_controller

def self.job_controller(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for JobController.

By default, this returns an instance of Google::Cloud::Dataproc::V1::JobController::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the JobController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About JobController

The JobController provides methods to manage jobs.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.node_group_controller

def self.node_group_controller(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for NodeGroupController.

By default, this returns an instance of Google::Cloud::Dataproc::V1::NodeGroupController::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the NodeGroupController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About NodeGroupController

The NodeGroupControllerService provides methods to manage node groups of Compute Engine managed instances.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.session_controller

def self.session_controller(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SessionController.

By default, this returns an instance of Google::Cloud::Dataproc::V1::SessionController::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SessionController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About SessionController

The SessionController provides methods to manage interactive sessions.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.session_template_controller

def self.session_template_controller(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SessionTemplateController.

By default, this returns an instance of Google::Cloud::Dataproc::V1::SessionTemplateController::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SessionTemplateController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About SessionTemplateController

The SessionTemplateController provides methods to manage session templates.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.workflow_template_service

def self.workflow_template_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for WorkflowTemplateService.

By default, this returns an instance of Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the WorkflowTemplateService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About WorkflowTemplateService

The API interface for managing Workflow Templates in the Dataproc API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

Constants

VERSION

value: "2.6.1"