Class: Google::Apis::StorageV1::Object

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

Overview

An object.

Defined Under Namespace

Classes: CustomerEncryption, Owner

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) ⇒ Object

Returns a new instance of Object



920
921
922
 
# File 'generated/google/apis/storage_v1/classes.rb', line 920

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

Instance Attribute Details

#acl ⇒ Array<Google::Apis::StorageV1::ObjectAccessControl>

Access controls on the object. Corresponds to the JSON property acl

Returns:



775
776
777
 
# File 'generated/google/apis/storage_v1/classes.rb', line 775

def acl
  @acl
end

#bucket ⇒ String

The name of the bucket containing this object. Corresponds to the JSON property bucket

Returns:

  • (String) 


780
781
782
 
# File 'generated/google/apis/storage_v1/classes.rb', line 780

def bucket
  @bucket
end

#cache_control ⇒ String

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. Corresponds to the JSON property cacheControl

Returns:

  • (String) 


786
787
788
 
# File 'generated/google/apis/storage_v1/classes.rb', line 786

def cache_control
  @cache_control
end

#component_count ⇒ Fixnum

Number of underlying components that make up this object. Components are accumulated by compose operations. Corresponds to the JSON property componentCount

Returns:

  • (Fixnum) 


792
793
794
 
# File 'generated/google/apis/storage_v1/classes.rb', line 792

def component_count
  @component_count
end

#content_disposition ⇒ String

Content-Disposition of the object data. Corresponds to the JSON property contentDisposition

Returns:

  • (String) 


797
798
799
 
# File 'generated/google/apis/storage_v1/classes.rb', line 797

def content_disposition
  @content_disposition
end

#content_encoding ⇒ String

Content-Encoding of the object data. Corresponds to the JSON property contentEncoding

Returns:

  • (String) 


802
803
804
 
# File 'generated/google/apis/storage_v1/classes.rb', line 802

def content_encoding
  @content_encoding
end

#content_language ⇒ String

Content-Language of the object data. Corresponds to the JSON property contentLanguage

Returns:

  • (String) 


807
808
809
 
# File 'generated/google/apis/storage_v1/classes.rb', line 807

def content_language
  @content_language
end

#content_type ⇒ String

Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream. Corresponds to the JSON property contentType

Returns:

  • (String) 


813
814
815
 
# File 'generated/google/apis/storage_v1/classes.rb', line 813

def content_type
  @content_type
end

#crc32c ⇒ String

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. Corresponds to the JSON property crc32c

Returns:

  • (String) 


820
821
822
 
# File 'generated/google/apis/storage_v1/classes.rb', line 820

def crc32c
  @crc32c
end

#customer_encryption ⇒ Google::Apis::StorageV1::Object::CustomerEncryption

Metadata of customer-supplied encryption key, if the object is encrypted by such a key. Corresponds to the JSON property customerEncryption

Returns:



826
827
828
 
# File 'generated/google/apis/storage_v1/classes.rb', line 826

def customer_encryption
  @customer_encryption
end

#etag ⇒ String

HTTP 1.1 Entity tag for the object. Corresponds to the JSON property etag

Returns:

  • (String) 


831
832
833
 
# File 'generated/google/apis/storage_v1/classes.rb', line 831

def etag
  @etag
end

#generation ⇒ String

The content generation of this object. Used for object versioning. Corresponds to the JSON property generation

Returns:

  • (String) 


836
837
838
 
# File 'generated/google/apis/storage_v1/classes.rb', line 836

def generation
  @generation
end

#id ⇒ String

The ID of the object, including the bucket name, object name, and generation number. Corresponds to the JSON property id

Returns:

  • (String) 


842
843
844
 
# File 'generated/google/apis/storage_v1/classes.rb', line 842

def id
  @id
end

#kind ⇒ String

The kind of item this is. For objects, this is always storage#object. Corresponds to the JSON property kind

Returns:

  • (String) 


847
848
849
 
# File 'generated/google/apis/storage_v1/classes.rb', line 847

def kind
  @kind
end

#md5_hash ⇒ String

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. Corresponds to the JSON property md5Hash

Returns:

  • (String) 


853
854
855
 
# File 'generated/google/apis/storage_v1/classes.rb', line 853

def md5_hash
  @md5_hash
end

#media_link ⇒ String

Media download link. Corresponds to the JSON property mediaLink

Returns:

  • (String) 


858
859
860
 
# File 'generated/google/apis/storage_v1/classes.rb', line 858

def media_link
  @media_link
end

#metadata ⇒ Hash<String,String>

User-provided metadata, in key/value pairs. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


863
864
865
 
# File 'generated/google/apis/storage_v1/classes.rb', line 863

def metadata
  @metadata
end

#metageneration ⇒ String

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. Corresponds to the JSON property metageneration

Returns:

  • (String) 


871
872
873
 
# File 'generated/google/apis/storage_v1/classes.rb', line 871

def metageneration
  @metageneration
end

#name ⇒ String

The name of the object. Required if not specified by URL parameter. Corresponds to the JSON property name

Returns:

  • (String) 


876
877
878
 
# File 'generated/google/apis/storage_v1/classes.rb', line 876

def name
  @name
end

#owner ⇒ Google::Apis::StorageV1::Object::Owner

The owner of the object. This will always be the uploader of the object. Corresponds to the JSON property owner

Returns:



881
882
883
 
# File 'generated/google/apis/storage_v1/classes.rb', line 881

def owner
  @owner
end

#self_link ⇒ String

The link to this object. Corresponds to the JSON property selfLink

Returns:

  • (String) 


886
887
888
 
# File 'generated/google/apis/storage_v1/classes.rb', line 886

def self_link
  @self_link
end

#size ⇒ String

Content-Length of the data in bytes. Corresponds to the JSON property size

Returns:

  • (String) 


891
892
893
 
# File 'generated/google/apis/storage_v1/classes.rb', line 891

def size
  @size
end

#storage_class ⇒ String

Storage class of the object. Corresponds to the JSON property storageClass

Returns:

  • (String) 


896
897
898
 
# File 'generated/google/apis/storage_v1/classes.rb', line 896

def storage_class
  @storage_class
end

#time_created ⇒ DateTime

The creation time of the object in RFC 3339 format. Corresponds to the JSON property timeCreated

Returns:

  • (DateTime) 


901
902
903
 
# File 'generated/google/apis/storage_v1/classes.rb', line 901

def time_created
  @time_created
end

#time_deleted ⇒ DateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. Corresponds to the JSON property timeDeleted

Returns:

  • (DateTime) 


907
908
909
 
# File 'generated/google/apis/storage_v1/classes.rb', line 907

def time_deleted
  @time_deleted
end

#time_storage_class_updated ⇒ DateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. Corresponds to the JSON property timeStorageClassUpdated

Returns:

  • (DateTime) 


913
914
915
 
# File 'generated/google/apis/storage_v1/classes.rb', line 913

def time_storage_class_updated
  @time_storage_class_updated
end

#updated ⇒ DateTime

The modification time of the object metadata in RFC 3339 format. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


918
919
920
 
# File 'generated/google/apis/storage_v1/classes.rb', line 918

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'generated/google/apis/storage_v1/classes.rb', line 925

def update!(**args)
  @acl = args[:acl] if args.key?(:acl)
  @bucket = args[:bucket] if args.key?(:bucket)
  @cache_control = args[:cache_control] if args.key?(:cache_control)
  @component_count = args[:component_count] if args.key?(:component_count)
  @content_disposition = args[:content_disposition] if args.key?(:content_disposition)
  @content_encoding = args[:content_encoding] if args.key?(:content_encoding)
  @content_language = args[:content_language] if args.key?(:content_language)
  @content_type = args[:content_type] if args.key?(:content_type)
  @crc32c = args[:crc32c] if args.key?(:crc32c)
  @customer_encryption = args[:customer_encryption] if args.key?(:customer_encryption)
  @etag = args[:etag] if args.key?(:etag)
  @generation = args[:generation] if args.key?(:generation)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @md5_hash = args[:md5_hash] if args.key?(:md5_hash)
  @media_link = args[:media_link] if args.key?(:media_link)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metageneration = args[:metageneration] if args.key?(:metageneration)
  @name = args[:name] if args.key?(:name)
  @owner = args[:owner] if args.key?(:owner)
  @self_link = args[:self_link] if args.key?(:self_link)
  @size = args[:size] if args.key?(:size)
  @storage_class = args[:storage_class] if args.key?(:storage_class)
  @time_created = args[:time_created] if args.key?(:time_created)
  @time_deleted = args[:time_deleted] if args.key?(:time_deleted)
  @time_storage_class_updated = args[:time_storage_class_updated] if args.key?(:time_storage_class_updated)
  @updated = args[:updated] if args.key?(:updated)
end