lib/google/cloud/dataproc/v1/job_controller_client.rb in google-cloud-dataproc-0.2.1 vs lib/google/cloud/dataproc/v1/job_controller_client.rb in google-cloud-dataproc-0.2.2
- old
+ new
@@ -226,17 +226,17 @@
# @example
# require "google/cloud/dataproc"
#
# job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)
#
- # # TODO: Initialize +project_id+:
+ # # TODO: Initialize `project_id`:
# project_id = ''
#
- # # TODO: Initialize +region+:
+ # # TODO: Initialize `region`:
# region = ''
#
- # # TODO: Initialize +job+:
+ # # TODO: Initialize `job`:
# job = {}
# response = job_controller_client.submit_job(project_id, region, job)
def submit_job \
project_id,
@@ -273,17 +273,17 @@
# @example
# require "google/cloud/dataproc"
#
# job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)
#
- # # TODO: Initialize +project_id+:
+ # # TODO: Initialize `project_id`:
# project_id = ''
#
- # # TODO: Initialize +region+:
+ # # TODO: Initialize `region`:
# region = ''
#
- # # TODO: Initialize +job_id+:
+ # # TODO: Initialize `job_id`:
# job_id = ''
# response = job_controller_client.get_job(project_id, region, job_id)
def get_job \
project_id,
@@ -318,22 +318,22 @@
# submitted to the named cluster.
# @param job_state_matcher [Google::Cloud::Dataproc::V1::ListJobsRequest::JobStateMatcher]
# Optional. Specifies enumerated categories of jobs to list.
# (default = match ALL jobs).
#
- # If +filter+ is provided, +jobStateMatcher+ will be ignored.
+ # If `filter` is provided, `jobStateMatcher` will be ignored.
# @param filter [String]
# 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 +NON_ACTIVE+.
- # Only the logical +AND+ operator is supported; space-separated items are
- # treated as having an implicit +AND+ operator.
+ # 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 `NON_ACTIVE`.
+ # 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 options [Google::Gax::CallOptions]
@@ -351,14 +351,14 @@
# @example
# require "google/cloud/dataproc"
#
# job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)
#
- # # TODO: Initialize +project_id+:
+ # # TODO: Initialize `project_id`:
# project_id = ''
#
- # # TODO: Initialize +region+:
+ # # TODO: Initialize `region`:
# region = ''
#
# # Iterate over all results.
# job_controller_client.list_jobs(project_id, region).each do |element|
# # Process element.
@@ -408,11 +408,11 @@
# can also be provided.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# 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
+ # <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.
# A hash of the same form as `Google::Protobuf::FieldMask`
# can also be provided.
# @param options [Google::Gax::CallOptions]
@@ -426,23 +426,23 @@
# @example
# require "google/cloud/dataproc"
#
# job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)
#
- # # TODO: Initialize +project_id+:
+ # # TODO: Initialize `project_id`:
# project_id = ''
#
- # # TODO: Initialize +region+:
+ # # TODO: Initialize `region`:
# region = ''
#
- # # TODO: Initialize +job_id+:
+ # # TODO: Initialize `job_id`:
# job_id = ''
#
- # # TODO: Initialize +job+:
+ # # TODO: Initialize `job`:
# job = {}
#
- # # TODO: Initialize +update_mask+:
+ # # TODO: Initialize `update_mask`:
# update_mask = {}
# response = job_controller_client.update_job(project_id, region, job_id, job, update_mask)
def update_job \
project_id,
@@ -486,17 +486,17 @@
# @example
# require "google/cloud/dataproc"
#
# job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)
#
- # # TODO: Initialize +project_id+:
+ # # TODO: Initialize `project_id`:
# project_id = ''
#
- # # TODO: Initialize +region+:
+ # # TODO: Initialize `region`:
# region = ''
#
- # # TODO: Initialize +job_id+:
+ # # TODO: Initialize `job_id`:
# job_id = ''
# response = job_controller_client.cancel_job(project_id, region, job_id)
def cancel_job \
project_id,
@@ -512,11 +512,11 @@
req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::CancelJobRequest)
@cancel_job.call(req, options, &block)
end
# Deletes the job from the project. If the job is active, the delete fails,
- # and the response returns +FAILED_PRECONDITION+.
+ # and the response returns `FAILED_PRECONDITION`.
#
# @param project_id [String]
# Required. The ID of the Google Cloud Platform project that the job
# belongs to.
# @param region [String]
@@ -533,16 +533,16 @@
# @example
# require "google/cloud/dataproc"
#
# job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)
#
- # # TODO: Initialize +project_id+:
+ # # TODO: Initialize `project_id`:
# project_id = ''
#
- # # TODO: Initialize +region+:
+ # # TODO: Initialize `region`:
# region = ''
#
- # # TODO: Initialize +job_id+:
+ # # TODO: Initialize `job_id`:
# job_id = ''
# job_controller_client.delete_job(project_id, region, job_id)
def delete_job \
project_id,