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



1188
1189
1190
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1188

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:



1004
1005
1006
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1004

def acl
  @acl
end

#bucket ⇒ String

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

Returns:

  • (String) 


1009
1010
1011
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1009

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) 


1015
1016
1017
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1015

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) 


1021
1022
1023
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1021

def component_count
  @component_count
end

#content_disposition ⇒ String

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

Returns:

  • (String) 


1026
1027
1028
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1026

def content_disposition
  @content_disposition
end

#content_encoding ⇒ String

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

Returns:

  • (String) 


1031
1032
1033
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1031

def content_encoding
  @content_encoding
end

#content_language ⇒ String

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

Returns:

  • (String) 


1036
1037
1038
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1036

def content_language
  @content_language
end

#content_type ⇒ String

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. Corresponds to the JSON property contentType

Returns:

  • (String) 


1042
1043
1044
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1042

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) 


1049
1050
1051
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1049

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:



1055
1056
1057
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1055

def customer_encryption
  @customer_encryption
end

#etag ⇒ String

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

Returns:

  • (String) 


1060
1061
1062
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1060

def etag
  @etag
end

#event_based_hold ⇒ Boolean Also known as: event_based_hold?

Defines the Event-Based hold for an object. Event-Based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here bucket-level retention is 3 years and the event is loan being paid in full. In this example these objects will be held intact for any number of years until the event has occurred (hold is released) and then 3 more years after that. Corresponds to the JSON property eventBasedHold

Returns:

  • (Boolean) 


1072
1073
1074
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1072

def event_based_hold
  @event_based_hold
end

#generation ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1078
1079
1080
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1078

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) 


1084
1085
1086
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1084

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) 


1089
1090
1091
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1089

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. Limited availability; usable only by enabled projects. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


1095
1096
1097
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1095

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) 


1101
1102
1103
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1101

def md5_hash
  @md5_hash
end

#media_link ⇒ String

Media download link. Corresponds to the JSON property mediaLink

Returns:

  • (String) 


1106
1107
1108
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1106

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


1111
1112
1113
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1111

def metadata
  @metadata
end

#metageneration ⇒ Fixnum

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:

  • (Fixnum) 


1119
1120
1121
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1119

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) 


1124
1125
1126
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1124

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:



1129
1130
1131
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1129

def owner
  @owner
end

#retention_expiration_time ⇒ DateTime

Specifies the earliest time that the object's retention period expires. This value is server-determined and is in RFC 3339 format. Note 1: This field is not provided for objects with an active Event-Based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when TemporaryHold is set (so that the user can reason about policy without having to first unset the TemporaryHold). Corresponds to the JSON property retentionExpirationTime

Returns:

  • (DateTime) 


1139
1140
1141
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1139

def retention_expiration_time
  @retention_expiration_time
end

#self_link ⇒ String

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

Returns:

  • (String) 


1144
1145
1146
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1144

def self_link
  @self_link
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1149
1150
1151
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1149

def size
  @size
end

#storage_class ⇒ String

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

Returns:

  • (String) 


1154
1155
1156
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1154

def storage_class
  @storage_class
end

#temporary_hold ⇒ Boolean Also known as: temporary_hold?

Defines the temporary hold for an object. This flag is used to enforce a temporary hold on an object. While it is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Corresponds to the JSON property temporaryHold

Returns:

  • (Boolean) 


1163
1164
1165
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1163

def temporary_hold
  @temporary_hold
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


1169
1170
1171
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1169

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) 


1175
1176
1177
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1175

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) 


1181
1182
1183
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1181

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) 


1186
1187
1188
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1186

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'generated/google/apis/storage_v1/classes.rb', line 1193

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