google-api-ruby-client/generated/google/apis/dataproc_v1/service.rb

726 lines
42 KiB
Ruby
Raw Normal View History

2016-01-29 22:32:46 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module DataprocV1
# Google Cloud Dataproc API
#
2017-02-13 23:28:52 +00:00
# Manages Hadoop-based clusters and jobs on Google Cloud Platform.
2016-01-29 22:32:46 +00:00
#
# @example
# require 'google/apis/dataproc_v1'
#
# Dataproc = Google::Apis::DataprocV1 # Alias the module
# service = Dataproc::DataprocService.new
#
# @see https://cloud.google.com/dataproc/
class DataprocService < Google::Apis::Core::BaseService
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
2017-03-31 19:53:27 +00:00
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
2016-01-29 22:32:46 +00:00
def initialize
super('https://dataproc.googleapis.com/', '')
end
2017-03-31 19:53:27 +00:00
# Starts asynchronous cancellation on a long-running operation. The server makes
# a best effort to cancel the operation, but success is not guaranteed. If the
# server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
# Clients can use Operations.GetOperation or other methods to check whether the
# cancellation succeeded or whether the operation completed despite cancellation.
# On successful cancellation, the operation is not deleted; instead, it becomes
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to Code.CANCELLED.
# @param [String] name
# The name of the operation resource to be cancelled.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Empty] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Empty]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def cancel_operation(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.response_representation = Google::Apis::DataprocV1::Empty::Representation
command.response_class = Google::Apis::DataprocV1::Empty
command.params['name'] = name unless name.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2017-03-30 22:30:51 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Deletes a long-running operation. This method indicates that the client is no
# longer interested in the operation result. It does not cancel the operation.
# If the server doesn't support this method, it returns google.rpc.Code.
# UNIMPLEMENTED.
# @param [String] name
# The name of the operation resource to be deleted.
2017-03-30 22:30:51 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-03-30 22:30:51 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Empty] parsed result object
2017-03-30 22:30:51 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Empty]
2017-03-30 22:30:51 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def delete_operation(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataprocV1::Empty::Representation
command.response_class = Google::Apis::DataprocV1::Empty
command.params['name'] = name unless name.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Lists operations that match the specified filter in the request. If the server
# doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding
# below allows API services to override the binding to use different resource
# name schemes, such as users/*/operations.
# @param [String] name
# The name of the operation collection.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] filter
# The standard list filter.
# @param [String] page_token
# The standard list page token.
2017-02-13 23:28:52 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-02-13 23:28:52 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::ListOperationsResponse] parsed result object
2017-02-13 23:28:52 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::ListOperationsResponse]
2017-02-13 23:28:52 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def list_operations(name, page_size: nil, filter: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataprocV1::ListOperationsResponse::Representation
command.response_class = Google::Apis::DataprocV1::ListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageToken'] = page_token unless page_token.nil?
2017-02-13 23:28:52 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2017-02-13 23:28:52 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Gets the latest state of a long-running operation. Clients can use this method
# to poll the operation result at intervals as recommended by the API service.
# @param [String] name
# The name of the operation resource.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Operation]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def get_operation(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
command.params['name'] = name unless name.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Starts a job cancellation request. To access the job resource after
# cancellation, call regions/`region`/jobs.list or regions/`region`/jobs.get.
2016-02-25 23:16:53 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project that the job belongs to.
2016-02-25 23:16:53 +00:00
# @param [String] region
2017-02-13 23:28:52 +00:00
# Required The Cloud Dataproc region in which to handle the request.
2017-03-31 19:53:27 +00:00
# @param [String] job_id
# Required The job ID.
# @param [Google::Apis::DataprocV1::CancelJobRequest] cancel_job_request_object
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Job] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Job]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def cancel_job(project_id, region, job_id, cancel_job_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel', options)
command.request_representation = Google::Apis::DataprocV1::CancelJobRequest::Representation
command.request_object = cancel_job_request_object
command.response_representation = Google::Apis::DataprocV1::Job::Representation
command.response_class = Google::Apis::DataprocV1::Job
2016-02-25 23:16:53 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2017-03-31 19:53:27 +00:00
command.params['jobId'] = job_id unless job_id.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Gets the resource representation for a job in a project.
2016-02-25 23:16:53 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project that the job belongs to.
2016-02-25 23:16:53 +00:00
# @param [String] region
2017-02-13 23:28:52 +00:00
# Required The Cloud Dataproc region in which to handle the request.
2017-03-31 19:53:27 +00:00
# @param [String] job_id
# Required The job ID.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Job] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Job]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def get_job(project_id, region, job_id, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
command.response_representation = Google::Apis::DataprocV1::Job::Representation
command.response_class = Google::Apis::DataprocV1::Job
2016-02-25 23:16:53 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2017-03-31 19:53:27 +00:00
command.params['jobId'] = job_id unless job_id.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2017-03-30 22:30:51 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Updates a job in a project.
# @param [String] project_id
# Required The ID of the Google Cloud Platform project that the job belongs to.
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
# @param [String] job_id
# Required The job ID.
# @param [Google::Apis::DataprocV1::Job] job_object
# @param [String] update_mask
# Required Specifies the path, relative to <code>Job</code>, of the field to
# update. For example, to update the labels of a Job the <code>update_mask</code>
# parameter would be specified as <code>labels</code>, and the PATCH request
# body would specify the new value. <strong>Note:</strong> Currently, <code>
# labels</code> is the only field that can be updated.
2017-03-30 22:30:51 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-03-30 22:30:51 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Job] parsed result object
2017-03-30 22:30:51 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Job]
2017-03-30 22:30:51 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def patch_project_region_job(project_id, region, job_id, job_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
command.request_representation = Google::Apis::DataprocV1::Job::Representation
command.request_object = job_object
command.response_representation = Google::Apis::DataprocV1::Job::Representation
command.response_class = Google::Apis::DataprocV1::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Submits a job to a cluster.
# @param [String] project_id
# Required The ID of the Google Cloud Platform project that the job belongs to.
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
# @param [Google::Apis::DataprocV1::SubmitJobRequest] submit_job_request_object
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Job] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Job]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def submit_job(project_id, region, submit_job_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/jobs:submit', options)
command.request_representation = Google::Apis::DataprocV1::SubmitJobRequest::Representation
command.request_object = submit_job_request_object
command.response_representation = Google::Apis::DataprocV1::Job::Representation
command.response_class = Google::Apis::DataprocV1::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Deletes the job from the project. If the job is active, the delete fails, and
# the response returns FAILED_PRECONDITION.
# @param [String] project_id
# Required The ID of the Google Cloud Platform project that the job belongs to.
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
# @param [String] job_id
# Required The job ID.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-10 21:11:09 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Empty] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-10 21:11:09 +00:00
# @return [Google::Apis::DataprocV1::Empty]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def delete_job(project_id, region, job_id, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
2017-03-10 21:11:09 +00:00
command.response_representation = Google::Apis::DataprocV1::Empty::Representation
command.response_class = Google::Apis::DataprocV1::Empty
2017-03-31 19:53:27 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
command.params['jobId'] = job_id unless job_id.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Lists regions/`region`/jobs in a project.
# @param [String] project_id
# Required The ID of the Google Cloud Platform project that the job belongs to.
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
# @param [String] filter
# Optional A filter constraining the jobs to list. Filters are case-sensitive
# and have the following syntax:field = value AND field = value ...where field
# is status.state or labels.[KEY], and [KEY] is a label key. value can be * to
# match all values. status.state can be either ACTIVE or INACTIVE. Only the
# logical AND operator is supported; space-separated items are treated as having
# an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env =
# staging AND labels.starred = *
# @param [String] job_state_matcher
# Optional Specifies enumerated categories of jobs to list (default = match ALL
# jobs).
# @param [String] page_token
# Optional The page token, returned by a previous call, to request the next page
# of results.
# @param [Fixnum] page_size
# Optional The number of results to return in each response.
# @param [String] cluster_name
# Optional If set, the returned jobs list includes only jobs that were submitted
# to the named cluster.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::ListJobsResponse] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::ListJobsResponse]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def list_jobs(project_id, region, filter: nil, job_state_matcher: nil, page_token: nil, page_size: nil, cluster_name: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/regions/{region}/jobs', options)
command.response_representation = Google::Apis::DataprocV1::ListJobsResponse::Representation
command.response_class = Google::Apis::DataprocV1::ListJobsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
command.query['filter'] = filter unless filter.nil?
command.query['jobStateMatcher'] = job_state_matcher unless job_state_matcher.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['clusterName'] = cluster_name unless cluster_name.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Lists all regions/`region`/clusters in a project.
2016-02-25 23:16:53 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project that the cluster belongs
# to.
2016-02-25 23:16:53 +00:00
# @param [String] region
2017-02-13 23:28:52 +00:00
# Required The Cloud Dataproc region in which to handle the request.
2017-03-31 19:53:27 +00:00
# @param [String] filter
# Optional A filter constraining the clusters to list. Filters are case-
# sensitive and have the following syntax:field = value AND field = value ...
# where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is
# a label key. value can be * to match all values. status.state can be one of
# the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or
# UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE
# contains the DELETING and ERROR states. clusterName is the name of the cluster
# provided at creation time. Only the logical AND operator is supported; space-
# separated items are treated as having an implicit AND operator.Example filter:
# status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND
# labels.starred = *
# @param [String] page_token
# Optional The standard List page token.
# @param [Fixnum] page_size
# Optional The standard List page size.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::ListClustersResponse] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::ListClustersResponse]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def list_clusters(project_id, region, filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/regions/{region}/clusters', options)
command.response_representation = Google::Apis::DataprocV1::ListClustersResponse::Representation
command.response_class = Google::Apis::DataprocV1::ListClustersResponse
2016-02-25 23:16:53 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2017-03-31 19:53:27 +00:00
command.query['filter'] = filter unless filter.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Creates a cluster in a project.
2016-02-25 23:16:53 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project that the cluster belongs
# to.
2016-02-25 23:16:53 +00:00
# @param [String] region
2017-02-13 23:28:52 +00:00
# Required The Cloud Dataproc region in which to handle the request.
2017-03-31 19:53:27 +00:00
# @param [Google::Apis::DataprocV1::Cluster] cluster_object
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Operation]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def create_cluster(project_id, region, cluster_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/clusters', options)
command.request_representation = Google::Apis::DataprocV1::Cluster::Representation
command.request_object = cluster_object
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
2016-02-25 23:16:53 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Gets the resource representation for a cluster in a project.
2017-03-10 21:11:09 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project that the cluster belongs
# to.
2017-03-10 21:11:09 +00:00
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
2017-03-31 19:53:27 +00:00
# @param [String] cluster_name
# Required The cluster name.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Cluster] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Cluster]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def get_cluster(project_id, region, cluster_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
command.response_representation = Google::Apis::DataprocV1::Cluster::Representation
command.response_class = Google::Apis::DataprocV1::Cluster
2017-03-10 21:11:09 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2017-03-31 19:53:27 +00:00
command.params['clusterName'] = cluster_name unless cluster_name.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Updates a cluster in a project.
2017-03-10 21:11:09 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project the cluster belongs to.
2017-03-10 21:11:09 +00:00
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
2017-03-31 19:53:27 +00:00
# @param [String] cluster_name
# Required The cluster name.
# @param [Google::Apis::DataprocV1::Cluster] cluster_object
# @param [String] update_mask
# Required Specifies the path, relative to <code>Cluster</code>, of the field to
# update. For example, to change the number of workers in a cluster to 5, the <
# code>update_mask</code> parameter would be specified as <code>config.
# worker_config.num_instances</code>, 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 <
# code>update_mask</code> parameter would be <code>config.
# secondary_worker_config.num_instances</code>, and the PATCH request body would
# be set as follows:
# `
# "config":`
# "secondaryWorkerConfig":`
# "numInstances":"5"
# `
# `
# `
# <strong>Note:</strong> Currently, <code>config.worker_config.num_instances</
# code> and <code>config.secondary_worker_config.num_instances</code> are the
# only fields that can be updated.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Operation]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def patch_cluster(project_id, region, cluster_name, cluster_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
command.request_representation = Google::Apis::DataprocV1::Cluster::Representation
command.request_object = cluster_object
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
2017-03-10 21:11:09 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2017-03-31 19:53:27 +00:00
command.params['clusterName'] = cluster_name unless cluster_name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# Deletes a cluster in a project.
2017-03-10 21:11:09 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project that the cluster belongs
# to.
2017-03-10 21:11:09 +00:00
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
2017-03-27 22:14:47 +00:00
# @param [String] cluster_name
2017-03-31 19:53:27 +00:00
# Required The cluster name.
2016-02-25 23:16:53 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2016-02-25 23:16:53 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
2016-02-25 23:16:53 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Operation]
2016-02-25 23:16:53 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def delete_cluster(project_id, region, cluster_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
2017-03-10 21:11:09 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2017-03-31 19:53:27 +00:00
command.params['clusterName'] = cluster_name unless cluster_name.nil?
2016-02-25 23:16:53 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2016-02-25 23:16:53 +00:00
execute_or_queue_command(command, &block)
end
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Gets cluster diagnostic information. After the operation completes, the
# Operation.response field contains DiagnoseClusterOutputLocation.
2017-03-30 22:30:51 +00:00
# @param [String] project_id
2017-03-31 19:53:27 +00:00
# Required The ID of the Google Cloud Platform project that the cluster belongs
# to.
2017-03-30 22:30:51 +00:00
# @param [String] region
# Required The Cloud Dataproc region in which to handle the request.
2017-03-31 19:53:27 +00:00
# @param [String] cluster_name
# Required The cluster name.
# @param [Google::Apis::DataprocV1::DiagnoseClusterRequest] diagnose_cluster_request_object
2017-03-30 22:30:51 +00:00
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
2017-03-31 19:53:27 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-03-30 22:30:51 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
2017-03-30 22:30:51 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::DataprocV1::Operation]
2017-03-30 22:30:51 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
2017-03-31 19:53:27 +00:00
def diagnose_cluster(project_id, region, cluster_name, diagnose_cluster_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose', options)
command.request_representation = Google::Apis::DataprocV1::DiagnoseClusterRequest::Representation
command.request_object = diagnose_cluster_request_object
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
2017-03-30 22:30:51 +00:00
command.params['projectId'] = project_id unless project_id.nil?
command.params['region'] = region unless region.nil?
2017-03-31 19:53:27 +00:00
command.params['clusterName'] = cluster_name unless cluster_name.nil?
2017-03-30 22:30:51 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['fields'] = fields unless fields.nil?
2017-03-30 22:30:51 +00:00
execute_or_queue_command(command, &block)
end
2016-01-29 22:32:46 +00:00
protected
def apply_command_defaults(command)
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-31 19:53:27 +00:00
command.query['key'] = key unless key.nil?
2016-01-29 22:32:46 +00:00
end
end
end
end
end