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. These options only apply to transfers involving a POSIX filesystem and are ignored for other transfers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MetadataOptions

Returns a new instance of MetadataOptions.



635
636
637
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 635

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

Instance Attribute Details

#aclString

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)


587
588
589
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 587

def acl
  @acl
end

#gidString

Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer. By default, GID is not preserved. Corresponds to the JSON property gid

Returns:

  • (String)


593
594
595
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 593

def gid
  @gid
end

#kms_keyString

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)


601
602
603
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 601

def kms_key
  @kms_key
end

#modeString

Specifies how each file's mode attribute should be handled by the transfer. By default, mode is not preserved. Corresponds to the JSON property mode

Returns:

  • (String)


607
608
609
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 607

def mode
  @mode
end

#storage_classString

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)


614
615
616
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 614

def storage_class
  @storage_class
end

Specifies how symlinks should be handled by the transfer. By default, symlinks are not preserved. Corresponds to the JSON property symlink

Returns:

  • (String)


620
621
622
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 620

def symlink
  @symlink
end

#temporary_holdString

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)


627
628
629
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 627

def temporary_hold
  @temporary_hold
end

#uidString

Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer. By default, UID is not preserved. Corresponds to the JSON property uid

Returns:

  • (String)


633
634
635
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 633

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



640
641
642
643
644
645
646
647
648
649
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 640

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)
  @uid = args[:uid] if args.key?(:uid)
end