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

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

REST client for the StorageTransferService service.

Storage Transfer Service and its protos. Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.

Inherits

Object

Includes

Google::Cloud::StorageTransfer::V1::StorageTransferService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the StorageTransferService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all StorageTransferService clients
::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the StorageTransferService 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.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_agent_pool

def create_agent_pool(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool
def create_agent_pool(project_id: nil, agent_pool: nil, agent_pool_id: nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Creates an agent pool resource.

Overloads

def create_agent_pool(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Pass arguments to create_agent_pool via a request object, either of type CreateAgentPoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::CreateAgentPoolRequest, ::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_agent_pool(project_id: nil, agent_pool: nil, agent_pool_id: nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Pass arguments to create_agent_pool 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).

Parameters

project_id (::String) — Required. The ID of the Google Cloud project that owns the agent pool.
agent_pool (::Google::Cloud::StorageTransfer::V1::AgentPool, ::Hash) — Required. The agent pool to create.
agent_pool_id (::String) — Required. The ID of the agent pool to create.

The agent_pool_id must meet the following requirements:
- Length of 128 characters or less.
- Not start with the string goog.
- Start with a lowercase ASCII character, followed by:
  - Zero or more: lowercase Latin alphabet characters, numerals, hyphens (-), periods (.), underscores (_), or tildes (~).
  - One or more numerals or lowercase ASCII characters.
As expressed by the regular expression: ^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::StorageTransfer::V1::AgentPool)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::StorageTransfer::V1::AgentPool)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#create_transfer_job

def create_transfer_job(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob
def create_transfer_job(transfer_job: nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Creates a transfer job that runs periodically.

Overloads

def create_transfer_job(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Pass arguments to create_transfer_job via a request object, either of type CreateTransferJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::CreateTransferJobRequest, ::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_transfer_job(transfer_job: nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Pass arguments to create_transfer_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).

Parameter

transfer_job (::Google::Cloud::StorageTransfer::V1::TransferJob, ::Hash) — Required. The job to create.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::StorageTransfer::V1::TransferJob)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::StorageTransfer::V1::TransferJob)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#delete_agent_pool

def delete_agent_pool(request, options = nil) -> ::Google::Protobuf::Empty
def delete_agent_pool(name: nil) -> ::Google::Protobuf::Empty

Deletes an agent pool.

Overloads

def delete_agent_pool(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_agent_pool via a request object, either of type DeleteAgentPoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::DeleteAgentPoolRequest, ::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_agent_pool(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_agent_pool 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).

Parameter

name (::String) — Required. The name of the agent pool to delete.

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)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#delete_transfer_job

def delete_transfer_job(request, options = nil) -> ::Google::Protobuf::Empty
def delete_transfer_job(job_name: nil, project_id: nil) -> ::Google::Protobuf::Empty

Deletes a transfer job. Deleting a transfer job sets its status to DELETED.

Overloads

def delete_transfer_job(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_transfer_job via a request object, either of type DeleteTransferJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest, ::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_transfer_job(job_name: nil, project_id: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_transfer_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).

Parameters

job_name (::String) — Required. The job to delete.
project_id (::String) — Required. The ID of the Google Cloud project that owns the job.

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)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#get_agent_pool

def get_agent_pool(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool
def get_agent_pool(name: nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Gets an agent pool.

Overloads

def get_agent_pool(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Pass arguments to get_agent_pool via a request object, either of type GetAgentPoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::GetAgentPoolRequest, ::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_agent_pool(name: nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Pass arguments to get_agent_pool 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).

Parameter

name (::String) — Required. The name of the agent pool to get.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::StorageTransfer::V1::AgentPool)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::StorageTransfer::V1::AgentPool)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#get_google_service_account

def get_google_service_account(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount
def get_google_service_account(project_id: nil) -> ::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount

Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Overloads

def get_google_service_account(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount

Pass arguments to get_google_service_account via a request object, either of type GetGoogleServiceAccountRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::GetGoogleServiceAccountRequest, ::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_google_service_account(project_id: nil) -> ::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount

Pass arguments to get_google_service_account 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).

Parameter

project_id (::String) — Required. The ID of the Google Cloud project that the Google service account is associated with.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#get_transfer_job

def get_transfer_job(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob
def get_transfer_job(job_name: nil, project_id: nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Gets a transfer job.

Overloads

def get_transfer_job(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Pass arguments to get_transfer_job via a request object, either of type GetTransferJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::GetTransferJobRequest, ::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_transfer_job(job_name: nil, project_id: nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Pass arguments to get_transfer_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).

Parameters

job_name (::String) — Required. The job to get.
project_id (::String) — Required. The ID of the Google Cloud project that owns the job.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::StorageTransfer::V1::TransferJob)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::StorageTransfer::V1::TransferJob)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#initialize

def initialize() { |config| ... } -> Client

Create a new StorageTransferService REST client object.

Yields

(config) — Configure the StorageTransferService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_agent_pools

def list_agent_pools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>
def list_agent_pools(project_id: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>

Lists agent pools.

Overloads

def list_agent_pools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>

Pass arguments to list_agent_pools via a request object, either of type ListAgentPoolsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::ListAgentPoolsRequest, ::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_agent_pools(project_id: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>

Pass arguments to list_agent_pools 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).

Parameters

project_id (::String) — Required. The ID of the Google Cloud project that owns the job.
filter (::String) — An optional list of query parameters specified as JSON text in the form of:

{"agentPoolNames":["agentpool1","agentpool2",...]}

Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.
page_size (::Integer) — The list page size. The max allowed value is 256.
page_token (::String) — The list page token.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#list_transfer_jobs

def list_transfer_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>
def list_transfer_jobs(filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>

Lists transfer jobs.

Overloads

def list_transfer_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>

Pass arguments to list_transfer_jobs via a request object, either of type ListTransferJobsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest, ::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_transfer_jobs(filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>

Pass arguments to list_transfer_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).

Parameters

filter (::String) — Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]}

Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required. jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED, DISABLED, and DELETED.
page_size (::Integer) — The list page size. The max allowed value is 256.
page_token (::String) — The list page token.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#operations_client

def operations_client() -> ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Operations)

#pause_transfer_operation

def pause_transfer_operation(request, options = nil) -> ::Google::Protobuf::Empty
def pause_transfer_operation(name: nil) -> ::Google::Protobuf::Empty

Pauses a transfer operation.

Overloads

def pause_transfer_operation(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to pause_transfer_operation via a request object, either of type PauseTransferOperationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::PauseTransferOperationRequest, ::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 pause_transfer_operation(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to pause_transfer_operation 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).

Parameter

name (::String) — Required. The name of the transfer operation.

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)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#resume_transfer_operation

def resume_transfer_operation(request, options = nil) -> ::Google::Protobuf::Empty
def resume_transfer_operation(name: nil) -> ::Google::Protobuf::Empty

Resumes a transfer operation that is paused.

Overloads

def resume_transfer_operation(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to resume_transfer_operation via a request object, either of type ResumeTransferOperationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::ResumeTransferOperationRequest, ::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 resume_transfer_operation(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to resume_transfer_operation 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).

Parameter

name (::String) — Required. The name of the transfer operation.

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)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#run_transfer_job

def run_transfer_job(request, options = nil) -> ::Gapic::Operation
def run_transfer_job(job_name: nil, project_id: nil) -> ::Gapic::Operation

Starts a new operation for the specified transfer job. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error is returned.

Overloads

def run_transfer_job(request, options = nil) -> ::Gapic::Operation

Pass arguments to run_transfer_job via a request object, either of type RunTransferJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::RunTransferJobRequest, ::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_transfer_job(job_name: nil, project_id: nil) -> ::Gapic::Operation

Pass arguments to run_transfer_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).

Parameters

job_name (::String) — Required. The name of the transfer job.
project_id (::String) — Required. The ID of the Google Cloud project that owns the transfer job.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#update_agent_pool

def update_agent_pool(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool
def update_agent_pool(agent_pool: nil, update_mask: nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Updates an existing agent pool resource.

Overloads

def update_agent_pool(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Pass arguments to update_agent_pool via a request object, either of type UpdateAgentPoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::UpdateAgentPoolRequest, ::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_agent_pool(agent_pool: nil, update_mask: nil) -> ::Google::Cloud::StorageTransfer::V1::AgentPool

Pass arguments to update_agent_pool 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).

Parameters

agent_pool (::Google::Cloud::StorageTransfer::V1::AgentPool, ::Hash) —
Required. The agent pool to update. agent_pool is expected to specify following fields:
- name
- display_name
- bandwidth_limit An UpdateAgentPoolRequest with any other fields is rejected with the error INVALID_ARGUMENT.
update_mask (::Google::Protobuf::FieldMask, ::Hash) —
The field mask of the fields in agentPool to update in this request. The following agentPool fields can be updated:
- display_name
- bandwidth_limit

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::StorageTransfer::V1::AgentPool)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::StorageTransfer::V1::AgentPool)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#update_transfer_job

def update_transfer_job(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob
def update_transfer_job(job_name: nil, project_id: nil, transfer_job: nil, update_transfer_job_field_mask: nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already.

Note: The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).

Overloads

def update_transfer_job(request, options = nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Pass arguments to update_transfer_job via a request object, either of type UpdateTransferJobRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest, ::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_transfer_job(job_name: nil, project_id: nil, transfer_job: nil, update_transfer_job_field_mask: nil) -> ::Google::Cloud::StorageTransfer::V1::TransferJob

Pass arguments to update_transfer_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).

Parameters

job_name (::String) — Required. The name of job to update.
project_id (::String) — Required. The ID of the Google Cloud project that owns the job.
transfer_job (::Google::Cloud::StorageTransfer::V1::TransferJob, ::Hash) — Required. The job to update. transferJob is expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. An UpdateTransferJobRequest that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires storagetransfer.jobs.delete permission.
update_transfer_job_field_mask (::Google::Protobuf::FieldMask, ::Hash) — The field mask of the fields in transferJob that are to be updated in this request. Fields in transferJob that can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update the transfer_spec of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::StorageTransfer::V1::TransferJob)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::StorageTransfer::V1::TransferJob)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.