lib/google/cloud/scheduler/v1/cloud_scheduler_client.rb in google-cloud-scheduler-1.1.1 vs lib/google/cloud/scheduler/v1/cloud_scheduler_client.rb in google-cloud-scheduler-1.1.2
- old
+ new
@@ -298,13 +298,11 @@
# Service calls
# Lists jobs.
#
# @param parent [String]
- # Required.
- #
- # The location name. For example:
+ # Required. The location name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID`.
# @param page_size [Integer]
# The maximum number of resources contained in the underlying API
# response. If page streaming is performed per-resource, this
# parameter does not affect the return value. If page streaming is
@@ -355,13 +353,11 @@
end
# Gets a job.
#
# @param name [String]
- # Required.
- #
- # The job name. For example:
+ # Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -388,18 +384,14 @@
end
# Creates a job.
#
# @param parent [String]
- # Required.
- #
- # The location name. For example:
+ # Required. The location name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID`.
# @param job [Google::Cloud::Scheduler::V1::Job | Hash]
- # Required.
- #
- # The job to add. The user can optionally specify a name for the
+ # Required. The job to add. The user can optionally specify a name for the
# job in {Google::Cloud::Scheduler::V1::Job#name name}. {Google::Cloud::Scheduler::V1::Job#name name} cannot be the same as an
# existing job. If a name is not specified then the system will
# generate a random unique name that will be returned
# ({Google::Cloud::Scheduler::V1::Job#name name}) in the response.
# A hash of the same form as `Google::Cloud::Scheduler::V1::Job`
@@ -444,14 +436,12 @@
# job to be in an {Google::Cloud::Scheduler::V1::Job::State::UPDATE_FAILED Job::State::UPDATE_FAILED} state. A job in this state may
# not be executed. If this happens, retry the UpdateJob request
# until a successful response is received.
#
# @param job [Google::Cloud::Scheduler::V1::Job | Hash]
- # Required.
+ # Required. The new job properties. {Google::Cloud::Scheduler::V1::Job#name name} must be specified.
#
- # The new job properties. {Google::Cloud::Scheduler::V1::Job#name name} must be specified.
- #
# Output only fields cannot be modified using UpdateJob.
# Any value specified for an output only field will be ignored.
# A hash of the same form as `Google::Cloud::Scheduler::V1::Job`
# can also be provided.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
@@ -492,13 +482,11 @@
end
# Deletes a job.
#
# @param name [String]
- # Required.
- #
- # The job name. For example:
+ # Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -531,13 +519,11 @@
# state of the job is stored in {Google::Cloud::Scheduler::V1::Job#state state}; if paused it
# will be set to {Google::Cloud::Scheduler::V1::Job::State::PAUSED Job::State::PAUSED}. A job must be in {Google::Cloud::Scheduler::V1::Job::State::ENABLED Job::State::ENABLED}
# to be paused.
#
# @param name [String]
- # Required.
- #
- # The job name. For example:
+ # Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -569,13 +555,11 @@
# state of a job is stored in {Google::Cloud::Scheduler::V1::Job#state Job#state}; after calling this method it
# will be set to {Google::Cloud::Scheduler::V1::Job::State::ENABLED Job::State::ENABLED}. A job must be in
# {Google::Cloud::Scheduler::V1::Job::State::PAUSED Job::State::PAUSED} to be resumed.
#
# @param name [String]
- # Required.
- #
- # The job name. For example:
+ # Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -605,12 +589,10 @@
#
# When this method is called, Cloud Scheduler will dispatch the job, even
# if the job is already running.
#
# @param name [String]
- # Required.
- #
- # The job name. For example:
+ # Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation