Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Jobs::Client.
Client for the Jobs service.
Cloud Run Job Control Plane API.
Inherits
- Object
Includes
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Jobs clients ::Google::Cloud::Run::V2::Jobs::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Jobs Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_job
def create_job(request, options = nil) -> ::Gapic::Operation
def create_job(parent: nil, job: nil, job_id: nil, validate_only: nil) -> ::Gapic::Operation
Creates a Job.
def create_job(request, options = nil) -> ::Gapic::Operation
create_job
via a request object, either of type
CreateJobRequest or an equivalent Hash.
- request (::Google::Cloud::Run::V2::CreateJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_job(parent: nil, job: nil, job_id: nil, validate_only: nil) -> ::Gapic::Operation
create_job
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The location and project in which this Job should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
- job (::Google::Cloud::Run::V2::Job, ::Hash) — Required. The Job instance to create.
- job_id (::String) — Required. The unique identifier for the Job. The name of the job becomes {parent}/jobs/{job_id}.
- validate_only (::Boolean) — Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Run::V2::CreateJobRequest.new # Call the create_job method. result = client.create_job request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_job
def delete_job(request, options = nil) -> ::Gapic::Operation
def delete_job(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
Deletes a Job.
def delete_job(request, options = nil) -> ::Gapic::Operation
delete_job
via a request object, either of type
DeleteJobRequest or an equivalent Hash.
- request (::Google::Cloud::Run::V2::DeleteJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_job(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
delete_job
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
- validate_only (::Boolean) — Indicates that the request should be validated without actually deleting any resources.
- etag (::String) — A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Run::V2::DeleteJobRequest.new # Call the delete_job method. result = client.delete_job request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via a request object, either of type
Iam::V1::GetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
-
options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::GetIamPolicyRequest.new # Call the get_iam_policy method. result = client.get_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#get_job
def get_job(request, options = nil) -> ::Google::Cloud::Run::V2::Job
def get_job(name: nil) -> ::Google::Cloud::Run::V2::Job
Gets information about a Job.
def get_job(request, options = nil) -> ::Google::Cloud::Run::V2::Job
get_job
via a request object, either of type
GetJobRequest or an equivalent Hash.
- request (::Google::Cloud::Run::V2::GetJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_job(name: nil) -> ::Google::Cloud::Run::V2::Job
get_job
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Run::V2::Job)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Run::V2::GetJobRequest.new # Call the get_job method. result = client.get_job request # The returned object is of type Google::Cloud::Run::V2::Job. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new Jobs client object.
- (config) — Configure the Jobs client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Run::V2::Jobs::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Run::V2::Jobs::Client.new do |config| config.timeout = 10.0 end
#list_jobs
def list_jobs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Job>
def list_jobs(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Job>
Lists Jobs.
def list_jobs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Job>
list_jobs
via a request object, either of type
ListJobsRequest or an equivalent Hash.
- request (::Google::Cloud::Run::V2::ListJobsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_jobs(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Job>
list_jobs
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
- page_size (::Integer) — Maximum number of Jobs to return in this call.
- page_token (::String) — A page token received from a previous call to ListJobs. All other parameters must match.
- show_deleted (::Boolean) — If true, returns deleted (but unexpired) resources along with active ones.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Job>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Job>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Run::V2::ListJobsRequest.new # Call the list_jobs method. result = client.list_jobs request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Run::V2::Job. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#operations_client
def operations_client() -> ::Google::Cloud::Run::V2::Jobs::Operations
Get the associated client for long-running operations.
#run_job
def run_job(request, options = nil) -> ::Gapic::Operation
def run_job(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
Triggers creation of a new Execution of this Job.
def run_job(request, options = nil) -> ::Gapic::Operation
run_job
via a request object, either of type
RunJobRequest or an equivalent Hash.
- request (::Google::Cloud::Run::V2::RunJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def run_job(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
run_job
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
- validate_only (::Boolean) — Indicates that the request should be validated without actually deleting any resources.
- etag (::String) — A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Run::V2::RunJobRequest.new # Call the run_job method. result = client.run_job request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via a request object, either of type
Iam::V1::SetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
-
policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. -
update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
the fields in the mask will be modified. If no mask is provided, the
following default mask is used:
paths: "bindings, etag"
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::SetIamPolicyRequest.new # Call the set_iam_policy method. result = client.set_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified Project.
There are no permissions required for making this API call.
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via a request object, either of type
Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
- request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
-
permissions (::Array<::String>) — The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::TestIamPermissionsRequest.new # Call the test_iam_permissions method. result = client.test_iam_permissions request # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse. p result
#update_job
def update_job(request, options = nil) -> ::Gapic::Operation
def update_job(job: nil, validate_only: nil, allow_missing: nil) -> ::Gapic::Operation
Updates a Job.
def update_job(request, options = nil) -> ::Gapic::Operation
update_job
via a request object, either of type
UpdateJobRequest or an equivalent Hash.
- request (::Google::Cloud::Run::V2::UpdateJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_job(job: nil, validate_only: nil, allow_missing: nil) -> ::Gapic::Operation
update_job
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- job (::Google::Cloud::Run::V2::Job, ::Hash) — Required. The Job to be updated.
- validate_only (::Boolean) — Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.
- allow_missing (::Boolean) — If set to true, and if the Job does not exist, it will create a new one. Caller must have both create and update permissions for this call if this is set to true.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/run/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Run::V2::Jobs::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Run::V2::UpdateJobRequest.new # Call the update_job method. result = client.update_job request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end