Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::ServiceStub (v0.10.0)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::ServiceStub.

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

Inherits

  • Object

Methods

#create_agent_pool

def create_agent_pool(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Baseline implementation for the create_agent_pool REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_transfer_job

def create_transfer_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Baseline implementation for the create_transfer_job REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_agent_pool

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

Baseline implementation for the delete_agent_pool REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_transfer_job

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

Baseline implementation for the delete_transfer_job REST call

Parameters
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_agent_pool

def get_agent_pool(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Baseline implementation for the get_agent_pool REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_google_service_account

def get_google_service_account(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount

Baseline implementation for the get_google_service_account REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_transfer_job

def get_transfer_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Baseline implementation for the get_transfer_job REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#list_agent_pools

def list_agent_pools(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::ListAgentPoolsResponse

Baseline implementation for the list_agent_pools REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_transfer_jobs

def list_transfer_jobs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::ListTransferJobsResponse

Baseline implementation for the list_transfer_jobs REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#pause_transfer_operation

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

Baseline implementation for the pause_transfer_operation REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#resume_transfer_operation

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

Baseline implementation for the resume_transfer_operation REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#run_transfer_job

def run_transfer_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the run_transfer_job REST call

Parameters
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_agent_pool

def update_agent_pool(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Baseline implementation for the update_agent_pool REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_transfer_job

def update_transfer_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Baseline implementation for the update_transfer_job REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)