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.



1895
1896
1897
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1895

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

Instance Attribute Details

#aws_s3_compatible_data_source ⇒ Google::Apis::StoragetransferV1::AwsS3CompatibleData

An AwsS3CompatibleData resource. Corresponds to the JSON property awsS3CompatibleDataSource

Returns:



1776
1777
1778
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1776

def aws_s3_compatible_data_source
  @aws_s3_compatible_data_source
end

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



1782
1783
1784
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1782

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:



1793
1794
1795
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1793

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:



1801
1802
1803
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1801

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:



1809
1810
1811
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1809

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:



1817
1818
1819
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1817

def gcs_intermediate_data_location
  @gcs_intermediate_data_location
end

#hdfs_data_source ⇒ Google::Apis::StoragetransferV1::HdfsData

An HdfsData resource specifies a path within an HDFS entity (e.g. a cluster). All cluster-specific settings, such as namenodes and ports, are configured on the transfer agents servicing requests, so HdfsData only contains the root path to the data in our transfer. Corresponds to the JSON property hdfsDataSource

Returns:



1825
1826
1827
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1825

def hdfs_data_source
  @hdfs_data_source
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:



1850
1851
1852
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1850

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:



1861
1862
1863
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1861

def object_conditions
  @object_conditions
end

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

A POSIX filesystem resource. Corresponds to the JSON property posixDataSink

Returns:



1866
1867
1868
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1866

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:



1871
1872
1873
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1871

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) 


1877
1878
1879
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1877

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) 


1883
1884
1885
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1883

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:



1888
1889
1890
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1888

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:



1893
1894
1895
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1893

def transfer_options
  @transfer_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1900

def update!(**args)
  @aws_s3_compatible_data_source = args[:aws_s3_compatible_data_source] if args.key?(:aws_s3_compatible_data_source)
  @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)
  @hdfs_data_source = args[:hdfs_data_source] if args.key?(:hdfs_data_source)
  @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