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

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

Overview

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.

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 REST client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the StorageTransferService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 135

def initialize
  # 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 = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::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 = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @storage_transfer_service_stub.logger(stub: true)&.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::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



189
190
191
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 189

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::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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:



105
106
107
108
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 105

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

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 1065

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
  call_metadata = @config.rpcs.create_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_agent_pool.timeout,
                         metadata:     call_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.create_agent_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 331

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
  call_metadata = @config.rpcs.create_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_transfer_job.timeout,
                         metadata:     call_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.create_transfer_job request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 1414

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
  call_metadata = @config.rpcs.delete_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_agent_pool.timeout,
                         metadata:     call_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.delete_agent_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 970

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
  call_metadata = @config.rpcs.delete_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_transfer_job.timeout,
                         metadata:     call_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.delete_transfer_job request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 1239

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
  call_metadata = @config.rpcs.get_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_agent_pool.timeout,
                         metadata:     call_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.get_agent_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



253
254
255
256
257
258
259
260
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
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 253

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
  call_metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs..timeout,
                         metadata:     call_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. request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 525

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
  call_metadata = @config.rpcs.get_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_transfer_job.timeout,
                         metadata:     call_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.get_transfer_job request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_agent_pools(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool> #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.

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::Rest::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::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) (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::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) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 1334

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
  call_metadata = @config.rpcs.list_agent_pools.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_agent_pools.timeout,
                         metadata:     call_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.list_agent_pools request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @storage_transfer_service_stub, :list_agent_pools, "agent_pools", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_transfer_jobs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob> #list_transfer_jobs(filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::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::Rest::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::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) (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::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) (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",...],
  "dataBackend":"QUERY_REPLICATION_CONFIGS",
  "sourceBucket":"source-bucket-name",
  "sinkBucket":"sink-bucket-name",
}

      The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks.

      • projectId is required.
      • Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. jobNames and jobStatuses are optional. Valid values are case-insensitive:
      • Specify "dataBackend":"QUERY_REPLICATION_CONFIGS" to return a list of cross-bucket replication jobs.
      • Limit the results to jobs from a particular bucket with sourceBucket and/or to a particular bucket with sinkBucket.
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 637

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
  call_metadata = @config.rpcs.list_transfer_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_transfer_jobs.timeout,
                         metadata:     call_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.list_transfer_jobs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @storage_transfer_service_stub, :list_transfer_jobs, "transfer_jobs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


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

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

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 717

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
  call_metadata = @config.rpcs.pause_transfer_operation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.pause_transfer_operation.timeout,
                         metadata:     call_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.pause_transfer_operation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 795

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
  call_metadata = @config.rpcs.resume_transfer_operation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.resume_transfer_operation.timeout,
                         metadata:     call_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.resume_transfer_operation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (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.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 886

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
  call_metadata = @config.rpcs.run_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.run_transfer_job.timeout,
                         metadata:     call_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.run_transfer_job request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


115
116
117
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 115

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

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 1161

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
  call_metadata = @config.rpcs.update_agent_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_agent_pool.timeout,
                         metadata:     call_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.update_agent_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb', line 444

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
  call_metadata = @config.rpcs.update_transfer_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_transfer_job.timeout,
                         metadata:     call_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.update_transfer_job request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end