Class: Google::Apis::StoragetransferV1::MetadataOptions

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

Specifies the metadata options for running a transfer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MetadataOptions

Returns a new instance of MetadataOptions.



690
691
692
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 690

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

Instance Attribute Details

#acl ⇒ String

Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as ACL_DESTINATION_BUCKET_DEFAULT. Corresponds to the JSON property acl

Returns:

  • (String) 


631
632
633
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 631

def acl
  @acl
end

#gid ⇒ String

Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer. By default, GID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers. Corresponds to the JSON property gid

Returns:

  • (String) 


638
639
640
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 638

def gid
  @gid
end

#kms_key ⇒ String

Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as KMS_KEY_DESTINATION_BUCKET_DEFAULT. Corresponds to the JSON property kmsKey

Returns:

  • (String) 


646
647
648
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 646

def kms_key
  @kms_key
end

#mode ⇒ String

Specifies how each file's mode attribute should be handled by the transfer. By default, mode is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers. Corresponds to the JSON property mode

Returns:

  • (String) 


653
654
655
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 653

def mode
  @mode
end

#storage_class ⇒ String

Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets. If unspecified, the default behavior is the same as STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT. Corresponds to the JSON property storageClass

Returns:

  • (String) 


660
661
662
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 660

def storage_class
  @storage_class
end

#symlink ⇒ String

Specifies how symlinks should be handled by the transfer. By default, symlinks are not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers. Corresponds to the JSON property symlink

Returns:

  • (String) 


667
668
669
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 667

def symlink
  @symlink
end

#temporary_hold ⇒ String

Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TEMPORARY_HOLD_PRESERVE. Corresponds to the JSON property temporaryHold

Returns:

  • (String) 


674
675
676
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 674

def temporary_hold
  @temporary_hold
end

#time_created ⇒ String

Specifies how each object's timeCreated metadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP. Corresponds to the JSON property timeCreated

Returns:

  • (String) 


681
682
683
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 681

def time_created
  @time_created
end

#uid ⇒ String

Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer. By default, UID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers. Corresponds to the JSON property uid

Returns:

  • (String) 


688
689
690
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 688

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 695

def update!(**args)
  @acl = args[:acl] if args.key?(:acl)
  @gid = args[:gid] if args.key?(:gid)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @mode = args[:mode] if args.key?(:mode)
  @storage_class = args[:storage_class] if args.key?(:storage_class)
  @symlink = args[:symlink] if args.key?(:symlink)
  @temporary_hold = args[:temporary_hold] if args.key?(:temporary_hold)
  @time_created = args[:time_created] if args.key?(:time_created)
  @uid = args[:uid] if args.key?(:uid)
end