Reference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::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
#acknowledge_task
def acknowledge_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the acknowledge_task REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::AcknowledgeTaskRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#buffer_task
def buffer_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::BufferTaskResponse
Baseline implementation for the buffer_task REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::BufferTaskRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::BufferTaskResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::BufferTaskResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#cancel_lease
def cancel_lease(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Task
Baseline implementation for the cancel_lease REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::CancelLeaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Task)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Task) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_queue
def create_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Queue
Baseline implementation for the create_queue REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Queue)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Queue) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_task
def create_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Task
Baseline implementation for the create_task REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Task)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Task) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_queue
def delete_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_queue REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_task
def delete_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_task REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_queue
def get_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Queue
Baseline implementation for the get_queue REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Queue)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Queue) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_task
def get_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Task
Baseline implementation for the get_task REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Task)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Task) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#lease_tasks
def lease_tasks(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse
Baseline implementation for the lease_tasks REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_queues
def list_queues(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::ListQueuesResponse
Baseline implementation for the list_queues REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::ListQueuesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::ListQueuesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_tasks
def list_tasks(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::ListTasksResponse
Baseline implementation for the list_tasks REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::ListTasksResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::ListTasksResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#pause_queue
def pause_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Queue
Baseline implementation for the pause_queue REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Queue)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Queue) — A result object deserialized from the server's reply
- (::ArgumentError)
#purge_queue
def purge_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Queue
Baseline implementation for the purge_queue REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Queue)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Queue) — A result object deserialized from the server's reply
- (::ArgumentError)
#renew_lease
def renew_lease(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Task
Baseline implementation for the renew_lease REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::RenewLeaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Task)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Task) — A result object deserialized from the server's reply
- (::ArgumentError)
#resume_queue
def resume_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Queue
Baseline implementation for the resume_queue REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Queue)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Queue) — A result object deserialized from the server's reply
- (::ArgumentError)
#run_task
def run_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Task
Baseline implementation for the run_task REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Task)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Task) — A result object deserialized from the server's reply
- (::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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply
- (::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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::TestIamPermissionsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_queue
def update_queue(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Tasks::V2beta2::Queue
Baseline implementation for the update_queue REST call
- request_pb (::Google::Cloud::Tasks::V2beta2::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Tasks::V2beta2::Queue)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Tasks::V2beta2::Queue) — A result object deserialized from the server's reply
- (::ArgumentError)