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

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

Overview

Configuration for running a transfer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TransferSpec

Returns a new instance of TransferSpec

[View source]

1074
1075
1076
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1074

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:


1012
1013
1014
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1012

def aws_s3_data_source
  @aws_s3_data_source
end

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

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

Returns:


1019
1020
1021
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1019

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 Google Cloud Storage object's name and its lastModificationTime refers to the object's updated time, which changes when the content or the metadata of the object is updated. Corresponds to the JSON property gcsDataSource

Returns:


1026
1027
1028
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1026

def gcs_data_source
  @gcs_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/<URL-path> is transferred to a data sink, the name of the object at the data sink is <hostname>/<URL-path>.
  • If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred.
  • If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see Generating MD5 hashes
  • Ensure that each URL you specify is publicly accessible. For example, in Google 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:


1061
1062
1063
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1061

def http_data_source
  @http_data_source
end

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

Conditions that determine which objects will be transferred. Corresponds to the JSON property objectConditions

Returns:


1066
1067
1068
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1066

def object_conditions
  @object_conditions
end

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

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

Returns:


1072
1073
1074
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1072

def transfer_options
  @transfer_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 1079

def update!(**args)
  @aws_s3_data_source = args[:aws_s3_data_source] if args.key?(:aws_s3_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)
  @http_data_source = args[:http_data_source] if args.key?(:http_data_source)
  @object_conditions = args[:object_conditions] if args.key?(:object_conditions)
  @transfer_options = args[:transfer_options] if args.key?(:transfer_options)
end