Cloud Tasks V2 API - Class Google::Cloud::Tasks::V2::CloudTasks::Rest::ServiceStub (v0.8.0)

Version 0.8.0

• 0.11.0 (latest)
• 0.10.2
• 0.9.0
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.6

Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::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::V2::Queue

Baseline implementation for the create_queue REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Queue)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Queue) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_task

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

Baseline implementation for the create_task REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Task)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Task) — A result object deserialized from the server's reply

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::V2::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

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

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::V2::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

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#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

• result (::Google::Iam::V1::Policy)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_queue

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

Baseline implementation for the get_queue REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Queue)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Queue) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_task

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

Baseline implementation for the get_task REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Task)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Task) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_queues

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

Baseline implementation for the list_queues REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::ListQueuesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::ListQueuesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_tasks

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

Baseline implementation for the list_tasks REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::ListTasksResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::ListTasksResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#pause_queue

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

Baseline implementation for the pause_queue REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Queue)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Queue) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#purge_queue

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

Baseline implementation for the purge_queue REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Queue)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Queue) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#resume_queue

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

Baseline implementation for the resume_queue REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Queue)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Queue) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#run_task

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

Baseline implementation for the run_task REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Task)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Task) — A result object deserialized from the server's reply

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

• result (::Google::Iam::V1::Policy)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply

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

• result (::Google::Iam::V1::TestIamPermissionsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Iam::V1::TestIamPermissionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_queue

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

Baseline implementation for the update_queue REST call

Parameters

• request_pb (::Google::Cloud::Tasks::V2::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

• result (::Google::Cloud::Tasks::V2::Queue)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Tasks::V2::Queue) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)