Class: Google::Apis::StoragetransferV1::TransferSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/storagetransfer_v1/classes.rb,
lib/google/apis/storagetransfer_v1/representations.rb,
lib/google/apis/storagetransfer_v1/representations.rb

Overview

Configuration for running a transfer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TransferSpec

Returns a new instance of TransferSpec.



1600
1601
1602
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1600

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aws_s3_data_source ⇒ Google::Apis::StoragetransferV1::AwsS3Data

An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name. Corresponds to the JSON property awsS3DataSource

Returns:



1495
1496
1497
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1495

def aws_s3_data_source
  @aws_s3_data_source
end

#azure_blob_storage_data_source ⇒ Google::Apis::StoragetransferV1::AzureBlobStorageData

An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the Azure endpoint. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name. Corresponds to the JSON property azureBlobStorageDataSource

Returns:



1506
1507
1508
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1506

def azure_blob_storage_data_source
  @azure_blob_storage_data_source
end

#gcs_data_sink ⇒ Google::Apis::StoragetransferV1::GcsData

In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's updated property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. Corresponds to the JSON property gcsDataSink

Returns:



1514
1515
1516
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1514

def gcs_data_sink
  @gcs_data_sink
end

#gcs_data_source ⇒ Google::Apis::StoragetransferV1::GcsData

In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's updated property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. Corresponds to the JSON property gcsDataSource

Returns:



1522
1523
1524
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1522

def gcs_data_source
  @gcs_data_source
end

#gcs_intermediate_data_location ⇒ Google::Apis::StoragetransferV1::GcsData

In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's updated property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. Corresponds to the JSON property gcsIntermediateDataLocation

Returns:



1530
1531
1532
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1530

def gcs_intermediate_data_location
  @gcs_intermediate_data_location
end

#http_data_source ⇒ Google::Apis::StoragetransferV1::HttpData

An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0" , which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL — The location of the object. * Length — The size of the object in bytes. * MD5 — The base64- encoded MD5 hash of the object. For an example of a valid TSV file, see Transferring data from URLs. When transferring data based on a URL list, keep the following in mind: * When an object located at http(s)://hostname:port/ is transferred to a data sink, the name of the object at the data sink is /. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can share an object publicly and get a link to it. * Storage Transfer Service obeys robots. txt rules and requires the source HTTP server to support Range requests and to return a Content-Length header in each response. * ObjectConditions have no effect when filtering objects to transfer. Corresponds to the JSON property httpDataSource

Returns:



1555
1556
1557
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1555

def http_data_source
  @http_data_source
end

#object_conditions ⇒ Google::Apis::StoragetransferV1::ObjectConditions

Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the updated property of Cloud Storage objects, the LastModified field of S3 objects, and the Last-Modified header of Azure blobs. Transfers with a PosixFilesystem source or destination don't support ObjectConditions. Corresponds to the JSON property objectConditions

Returns:



1566
1567
1568
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1566

def object_conditions
  @object_conditions
end

#posix_data_sink ⇒ Google::Apis::StoragetransferV1::PosixFilesystem

A POSIX filesystem resource. Corresponds to the JSON property posixDataSink

Returns:



1571
1572
1573
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1571

def posix_data_sink
  @posix_data_sink
end

#posix_data_source ⇒ Google::Apis::StoragetransferV1::PosixFilesystem

A POSIX filesystem resource. Corresponds to the JSON property posixDataSource

Returns:



1576
1577
1578
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1576

def posix_data_source
  @posix_data_source
end

#sink_agent_pool_name ⇒ String

Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used. Corresponds to the JSON property sinkAgentPoolName

Returns:

  • (String) 


1582
1583
1584
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1582

def sink_agent_pool_name
  @sink_agent_pool_name
end

#source_agent_pool_name ⇒ String

Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used. Corresponds to the JSON property sourceAgentPoolName

Returns:

  • (String) 


1588
1589
1590
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1588

def source_agent_pool_name
  @source_agent_pool_name
end

#transfer_manifest ⇒ Google::Apis::StoragetransferV1::TransferManifest

Specifies where the manifest is located. Corresponds to the JSON property transferManifest

Returns:



1593
1594
1595
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1593

def transfer_manifest
  @transfer_manifest
end

#transfer_options ⇒ Google::Apis::StoragetransferV1::TransferOptions

TransferOptions define the actions to be performed on objects in a transfer. Corresponds to the JSON property transferOptions

Returns:



1598
1599
1600
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1598

def transfer_options
  @transfer_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1605

def update!(**args)
  @aws_s3_data_source = args[:aws_s3_data_source] if args.key?(:aws_s3_data_source)
  @azure_blob_storage_data_source = args[:azure_blob_storage_data_source] if args.key?(:azure_blob_storage_data_source)
  @gcs_data_sink = args[:gcs_data_sink] if args.key?(:gcs_data_sink)
  @gcs_data_source = args[:gcs_data_source] if args.key?(:gcs_data_source)
  @gcs_intermediate_data_location = args[:gcs_intermediate_data_location] if args.key?(:gcs_intermediate_data_location)
  @http_data_source = args[:http_data_source] if args.key?(:http_data_source)
  @object_conditions = args[:object_conditions] if args.key?(:object_conditions)
  @posix_data_sink = args[:posix_data_sink] if args.key?(:posix_data_sink)
  @posix_data_source = args[:posix_data_source] if args.key?(:posix_data_source)
  @sink_agent_pool_name = args[:sink_agent_pool_name] if args.key?(:sink_agent_pool_name)
  @source_agent_pool_name = args[:source_agent_pool_name] if args.key?(:source_agent_pool_name)
  @transfer_manifest = args[:transfer_manifest] if args.key?(:transfer_manifest)
  @transfer_options = args[:transfer_options] if args.key?(:transfer_options)
end