Class: Google::Cloud::StorageTransfer::V1::StorageTransferService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb

Overview

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#agent_pools_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new StorageTransferService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the StorageTransferService client.

Yield Parameters:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 133

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/storagetransfer/v1/transfer_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @storage_transfer_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @storage_transfer_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



196
197
198
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 196

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the StorageTransferService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "StorageTransfer", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [14]
    }

    default_config.rpcs.create_transfer_job.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



103
104
105
106
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 103

def configure
  yield @config if block_given?
  @config
end

#create_agent_pool(request, options = nil) ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool #create_agent_pool(project_id: nil, agent_pool: nil, agent_pool_id: nil) ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool

Creates an agent pool resource.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::CreateAgentPoolRequest.new

# Call the create_agent_pool method.
result = client.create_agent_pool request

# The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The ID of the Google Cloud project that owns the agent pool.

    • agent_pool (::Google::Cloud::StorageTransfer::V1::AgentPool, ::Hash) (defaults to: nil) —

      Required. The agent pool to create.

    • agent_pool_id (::String) (defaults to: nil) —

      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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 1105

def create_agent_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::CreateAgentPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.project_id
    header_params["project_id"] = request.project_id
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_agent_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_agent_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :create_agent_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_transfer_job(request, options = nil) ⇒ ::Google::Cloud::StorageTransfer::V1::TransferJob #create_transfer_job(transfer_job: nil) ⇒ ::Google::Cloud::StorageTransfer::V1::TransferJob

Creates a transfer job that runs periodically.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::CreateTransferJobRequest.new

# Call the create_transfer_job method.
result = client.create_transfer_job request

# The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 346

def create_transfer_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::CreateTransferJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_transfer_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_transfer_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :create_transfer_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_agent_pool(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_agent_pool(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an agent pool.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::DeleteAgentPoolRequest.new

# Call the delete_agent_pool method.
result = client.delete_agent_pool request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the agent pool to delete.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 1482

def delete_agent_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::DeleteAgentPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_agent_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_agent_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :delete_agent_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_transfer_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #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.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest.new

# Call the delete_transfer_job method.
result = client.delete_transfer_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The job to delete.

    • project_id (::String) (defaults to: nil) —

      Required. The ID of the Google Cloud project that owns the job.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 1003

def delete_transfer_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.job_name
    header_params["job_name"] = request.job_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_transfer_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_transfer_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :delete_transfer_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_agent_pool(request, options = nil) ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool #get_agent_pool(name: nil) ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool

Gets an agent pool.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::GetAgentPoolRequest.new

# Call the get_agent_pool method.
result = client.get_agent_pool request

# The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the agent pool to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 1293

def get_agent_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::GetAgentPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_agent_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_agent_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :get_agent_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_google_service_account(request, options = nil) ⇒ ::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount #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.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::GetGoogleServiceAccountRequest.new

# Call the get_google_service_account method.
result = client. request

# The returned object is of type Google::Cloud::StorageTransfer::V1::GoogleServiceAccount.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • project_id (::String) (defaults to: nil) —

      Required. The ID of the Google Cloud project that the Google service account is associated with.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 261

def  request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::GetGoogleServiceAccountRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.project_id
    header_params["project_id"] = request.project_id
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs..timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs..retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :get_google_service_account, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_transfer_job(request, options = nil) ⇒ ::Google::Cloud::StorageTransfer::V1::TransferJob #get_transfer_job(job_name: nil, project_id: nil) ⇒ ::Google::Cloud::StorageTransfer::V1::TransferJob

Gets a transfer job.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::GetTransferJobRequest.new

# Call the get_transfer_job method.
result = client.get_transfer_job request

# The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The job to get.

    • project_id (::String) (defaults to: nil) —

      Required. The ID of the Google Cloud project that owns the job.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 546

def get_transfer_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::GetTransferJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.job_name
    header_params["job_name"] = request.job_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_transfer_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_transfer_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :get_transfer_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists agent pools.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::ListAgentPoolsRequest.new

# Call the list_agent_pools method.
result = client.list_agent_pools request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::StorageTransfer::V1::AgentPool.
  p item
end

Overloads:

  • #list_agent_pools(request, options = nil) ⇒ ::Gapic::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_agent_pools(project_id: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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) (defaults to: nil) —

      Required. The ID of the Google Cloud project that owns the job.

    • filter (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      The list page size. The max allowed value is 256.

    • page_token (::String) (defaults to: nil) —

      The list page token.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 1395

def list_agent_pools request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::ListAgentPoolsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_agent_pools.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.project_id
    header_params["project_id"] = request.project_id
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_agent_pools.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_agent_pools.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :list_agent_pools, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @storage_transfer_service_stub, :list_agent_pools, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists transfer jobs.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest.new

# Call the list_transfer_jobs method.
result = client.list_transfer_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::StorageTransfer::V1::TransferJob.
  p item
end

Overloads:

  • #list_transfer_jobs(request, options = nil) ⇒ ::Gapic::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_transfer_jobs(filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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) (defaults to: nil) —

      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) (defaults to: nil) —

      The list page size. The max allowed value is 256.

    • page_token (::String) (defaults to: nil) —

      The list page token.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 650

def list_transfer_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_transfer_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_transfer_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_transfer_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :list_transfer_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @storage_transfer_service_stub, :list_transfer_jobs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


203
204
205
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 203

def logger
  @storage_transfer_service_stub.logger
end

#pause_transfer_operation(request, options = nil) ⇒ ::Google::Protobuf::Empty #pause_transfer_operation(name: nil) ⇒ ::Google::Protobuf::Empty

Pauses a transfer operation.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::PauseTransferOperationRequest.new

# Call the pause_transfer_operation method.
result = client.pause_transfer_operation request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the transfer operation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 729

def pause_transfer_operation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::PauseTransferOperationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.pause_transfer_operation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.pause_transfer_operation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.pause_transfer_operation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :pause_transfer_operation, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#resume_transfer_operation(request, options = nil) ⇒ ::Google::Protobuf::Empty #resume_transfer_operation(name: nil) ⇒ ::Google::Protobuf::Empty

Resumes a transfer operation that is paused.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::ResumeTransferOperationRequest.new

# Call the resume_transfer_operation method.
result = client.resume_transfer_operation request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the transfer operation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 814

def resume_transfer_operation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::ResumeTransferOperationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.resume_transfer_operation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.resume_transfer_operation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.resume_transfer_operation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :resume_transfer_operation, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#run_transfer_job(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::RunTransferJobRequest.new

# Call the run_transfer_job method.
result = client.run_transfer_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The name of the transfer job.

    • project_id (::String) (defaults to: nil) —

      Required. The ID of the Google Cloud project that owns the transfer job.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 912

def run_transfer_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::RunTransferJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.run_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.job_name
    header_params["job_name"] = request.job_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.run_transfer_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.run_transfer_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :run_transfer_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


113
114
115
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 113

def universe_domain
  @storage_transfer_service_stub.universe_domain
end

#update_agent_pool(request, options = nil) ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool #update_agent_pool(agent_pool: nil, update_mask: nil) ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool

Updates an existing agent pool resource.

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::UpdateAgentPoolRequest.new

# Call the update_agent_pool method.
result = client.update_agent_pool request

# The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 1208

def update_agent_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::UpdateAgentPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.agent_pool&.name
    header_params["agent_pool.name"] = request.agent_pool.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_agent_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_agent_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :update_agent_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_transfer_job(request, options = nil) ⇒ ::Google::Cloud::StorageTransfer::V1::TransferJob #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).

Examples:

Basic example

require "google/cloud/storage_transfer/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest.new

# Call the update_transfer_job method.
result = client.update_transfer_job request

# The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
p result

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb', line 458

def update_transfer_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.job_name
    header_params["job_name"] = request.job_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_transfer_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_transfer_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @storage_transfer_service_stub.call_rpc :update_transfer_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end