Cloud Tasks V2beta3 API - Class Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::ServiceStub (v0.16.0)

Reference documentation and code samples for the Cloud Tasks V2beta3 API class Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::ServiceStub.

REST service stub for the CloudTasks service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#create_queue

def create_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Queue

Baseline implementation for the create_queue REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::CreateQueueRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_task

def create_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Task

Baseline implementation for the create_task REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::CreateTaskRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_queue

def delete_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_queue REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::DeleteQueueRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_task

def delete_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_task REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::DeleteTaskRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_iam_policy

def get_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy

Baseline implementation for the get_iam_policy REST call

Parameters
  • request_pb (::Google::Iam::V1::GetIamPolicyRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_queue

def get_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Queue

Baseline implementation for the get_queue REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::GetQueueRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_task

def get_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Task

Baseline implementation for the get_task REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::GetTaskRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_queues

def list_queues(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::ListQueuesResponse

Baseline implementation for the list_queues REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::ListQueuesRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_tasks

def list_tasks(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::ListTasksResponse

Baseline implementation for the list_tasks REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::ListTasksRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#pause_queue

def pause_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Queue

Baseline implementation for the pause_queue REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::PauseQueueRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#purge_queue

def purge_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Queue

Baseline implementation for the purge_queue REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::PurgeQueueRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#resume_queue

def resume_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Queue

Baseline implementation for the resume_queue REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::ResumeQueueRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#run_task

def run_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Task

Baseline implementation for the run_task REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::RunTaskRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#set_iam_policy

def set_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy

Baseline implementation for the set_iam_policy REST call

Parameters
  • request_pb (::Google::Iam::V1::SetIamPolicyRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#test_iam_permissions

def test_iam_permissions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::TestIamPermissionsResponse

Baseline implementation for the test_iam_permissions REST call

Parameters
  • request_pb (::Google::Iam::V1::TestIamPermissionsRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_queue

def update_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta3::Queue

Baseline implementation for the update_queue REST call

Parameters
  • request_pb (::Google::Cloud::Tasks::V2beta3::UpdateQueueRequest) โ€” A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) โ€” Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) โ€” Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)