Google Cloud Storage Transfer V1 Client - Class TransferOptions (1.0.6)

Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class TransferOptions.

TransferOptions define the actions to be performed on objects in a transfer.

Generated from protobuf message google.storagetransfer.v1.TransferOptions

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ overwrite_objects_already_existing_in_sink bool

When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

↳ delete_objects_unique_in_sink bool

Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.

↳ delete_objects_from_source_after_transfer bool

Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.

↳ overwrite_when int

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

↳ metadata_options Google\Cloud\StorageTransfer\V1\MetadataOptions

Represents the selected metadata options for a transfer job.

getOverwriteObjectsAlreadyExistingInSink

When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

Returns
TypeDescription
bool

setOverwriteObjectsAlreadyExistingInSink

When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDeleteObjectsUniqueInSink

Whether objects that exist only in the sink should be deleted.

Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.

Returns
TypeDescription
bool

setDeleteObjectsUniqueInSink

Whether objects that exist only in the sink should be deleted.

Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDeleteObjectsFromSourceAfterTransfer

Whether objects should be deleted from the source after they are transferred to the sink.

Note: This option and delete_objects_unique_in_sink are mutually exclusive.

Returns
TypeDescription
bool

setDeleteObjectsFromSourceAfterTransfer

Whether objects should be deleted from the source after they are transferred to the sink.

Note: This option and delete_objects_unique_in_sink are mutually exclusive.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getOverwriteWhen

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

Returns
TypeDescription
int

setOverwriteWhen

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMetadataOptions

Represents the selected metadata options for a transfer job.

Returns
TypeDescription
Google\Cloud\StorageTransfer\V1\MetadataOptions|null

hasMetadataOptions

clearMetadataOptions

setMetadataOptions

Represents the selected metadata options for a transfer job.

Parameter
NameDescription
var Google\Cloud\StorageTransfer\V1\MetadataOptions
Returns
TypeDescription
$this