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.



930
931
932
 
# File 'generated/google/apis/storage_v1/classes.rb', line 930

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:



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

def acl
  @acl
end

#bucket ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

def component_count
  @component_count
end

#content_disposition ⇒ String

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

Returns:

  • (String) 


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

def content_disposition
  @content_disposition
end

#content_encoding ⇒ String

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

Returns:

  • (String) 


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

def content_encoding
  @content_encoding
end

#content_language ⇒ String

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

Returns:

  • (String) 


818
819
820
 
# File 'generated/google/apis/storage_v1/classes.rb', line 818

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) 


824
825
826
 
# File 'generated/google/apis/storage_v1/classes.rb', line 824

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) 


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

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:



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

def customer_encryption
  @customer_encryption
end

#etag ⇒ String

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

Returns:

  • (String) 


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

def etag
  @etag
end

#generation ⇒ String

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

Returns:

  • (String) 


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

def generation
  @generation
end

#id ⇒ String

The ID of the object. Corresponds to the JSON property id

Returns:

  • (String) 


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

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) 


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

def kind
  @kind
end

#kms_key_name ⇒ String

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


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

def kms_key_name
  @kms_key_name
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) 


869
870
871
 
# File 'generated/google/apis/storage_v1/classes.rb', line 869

def md5_hash
  @md5_hash
end

#media_link ⇒ String

Media download link. Corresponds to the JSON property mediaLink

Returns:

  • (String) 


874
875
876
 
# File 'generated/google/apis/storage_v1/classes.rb', line 874

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


879
880
881
 
# File 'generated/google/apis/storage_v1/classes.rb', line 879

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) 


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

def metageneration
  @metageneration
end

#name ⇒ String

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

Returns:

  • (String) 


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

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:



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

def owner
  @owner
end

#self_link ⇒ String

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

Returns:

  • (String) 


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

def self_link
  @self_link
end

#size ⇒ String

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

Returns:

  • (String) 


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

def size
  @size
end

#storage_class ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


923
924
925
 
# File 'generated/google/apis/storage_v1/classes.rb', line 923

def time_deleted
  @time_deleted
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


928
929
930
 
# File 'generated/google/apis/storage_v1/classes.rb', line 928

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'generated/google/apis/storage_v1/classes.rb', line 935

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