Class Object (2.20.0)

public final class Object extends GeneratedMessageV3 implements ObjectOrBuilder

An object.

Protobuf type google.storage.v2.Object

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Object

Implements

ObjectOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ACL_FIELD_NUMBER

public static final int ACL_FIELD_NUMBER

Field Value

Type	Description
`int`

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER

Field Value

Type	Description
`int`

CACHE_CONTROL_FIELD_NUMBER

public static final int CACHE_CONTROL_FIELD_NUMBER

Field Value

Type	Description
`int`

CHECKSUMS_FIELD_NUMBER

public static final int CHECKSUMS_FIELD_NUMBER

Field Value

Type	Description
`int`

COMPONENT_COUNT_FIELD_NUMBER

public static final int COMPONENT_COUNT_FIELD_NUMBER

Field Value

Type	Description
`int`

CONTENT_DISPOSITION_FIELD_NUMBER

public static final int CONTENT_DISPOSITION_FIELD_NUMBER

Field Value

Type	Description
`int`

CONTENT_ENCODING_FIELD_NUMBER

public static final int CONTENT_ENCODING_FIELD_NUMBER

Field Value

Type	Description
`int`

CONTENT_LANGUAGE_FIELD_NUMBER

public static final int CONTENT_LANGUAGE_FIELD_NUMBER

Field Value

Type	Description
`int`

CONTENT_TYPE_FIELD_NUMBER

public static final int CONTENT_TYPE_FIELD_NUMBER

Field Value

Type	Description
`int`

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

CUSTOMER_ENCRYPTION_FIELD_NUMBER

public static final int CUSTOMER_ENCRYPTION_FIELD_NUMBER

Field Value

Type	Description
`int`

CUSTOM_TIME_FIELD_NUMBER

public static final int CUSTOM_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

Field Value

Type	Description
`int`

EVENT_BASED_HOLD_FIELD_NUMBER

public static final int EVENT_BASED_HOLD_FIELD_NUMBER

Field Value

Type	Description
`int`

GENERATION_FIELD_NUMBER

public static final int GENERATION_FIELD_NUMBER

Field Value

Type	Description
`int`

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER

Field Value

Type	Description
`int`

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

Field Value

Type	Description
`int`

METAGENERATION_FIELD_NUMBER

public static final int METAGENERATION_FIELD_NUMBER

Field Value

Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
`int`

OWNER_FIELD_NUMBER

public static final int OWNER_FIELD_NUMBER

Field Value

Type	Description
`int`

RETENTION_EXPIRE_TIME_FIELD_NUMBER

public static final int RETENTION_EXPIRE_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

SIZE_FIELD_NUMBER

public static final int SIZE_FIELD_NUMBER

Field Value

Type	Description
`int`

STORAGE_CLASS_FIELD_NUMBER

public static final int STORAGE_CLASS_FIELD_NUMBER

Field Value

Type	Description
`int`

TEMPORARY_HOLD_FIELD_NUMBER

public static final int TEMPORARY_HOLD_FIELD_NUMBER

Field Value

Type	Description
`int`

UPDATE_STORAGE_CLASS_TIME_FIELD_NUMBER

public static final int UPDATE_STORAGE_CLASS_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

Static Methods

getDefaultInstance()

public static Object getDefaultInstance()

Returns

Type	Description
`Object`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

newBuilder()

public static Object.Builder newBuilder()

Returns

Type	Description
`Object.Builder`

newBuilder(Object prototype)

public static Object.Builder newBuilder(Object prototype)

Parameter

Name	Description
`prototype`	`Object`

Returns

Type	Description
`Object.Builder`

parseDelimitedFrom(InputStream input)

public static Object parseDelimitedFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Object parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`IOException`

parseFrom(byte[] data)

public static Object parseFrom(byte[] data)

Parameter

Name	Description
`data`	`byte[]`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Object parseFrom(ByteString data)

Parameter

Name	Description
`data`	`ByteString`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Object parseFrom(CodedInputStream input)

Parameter

Name	Description
`input`	`CodedInputStream`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input)

public static Object parseFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Object parseFrom(ByteBuffer data)

Parameter

Name	Description
`data`	`ByteBuffer`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Object`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Object> parser()

Returns

Type	Description
`Parser<Object>`

Methods

containsMetadata(String key)

public boolean containsMetadata(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
`obj`	`Object`

Returns

Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAcl(int index)

public ObjectAccessControl getAcl(int index)

Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`ObjectAccessControl`

getAclCount()

public int getAclCount()

Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Returns

Type	Description
`int`

getAclList()

public List<ObjectAccessControl> getAclList()

Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Returns

Type	Description
`List<ObjectAccessControl>`

getAclOrBuilder(int index)

public ObjectAccessControlOrBuilder getAclOrBuilder(int index)

Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`ObjectAccessControlOrBuilder`

getAclOrBuilderList()

public List<? extends ObjectAccessControlOrBuilder> getAclOrBuilderList()

Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Returns

Type	Description
`List<? extends com.google.storage.v2.ObjectAccessControlOrBuilder>`

getBucket()

public String getBucket()

Immutable. The name of the bucket containing this object.

string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`String`	The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Immutable. The name of the bucket containing this object.

string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`ByteString`	The bytes for bucket.

getCacheControl()

public String getCacheControl()

Cache-Control directive for the object data, matching https://tools.ietf.org/html/rfc7234#section-5.2". If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.

string cache_control = 9;

Returns

Type	Description
`String`	The cacheControl.

getCacheControlBytes()

public ByteString getCacheControlBytes()

string cache_control = 9;

Returns

Type	Description
`ByteString`	The bytes for cacheControl.

getChecksums()

public ObjectChecksums getChecksums()

Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests.

.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ObjectChecksums`	The checksums.

getChecksumsOrBuilder()

public ObjectChecksumsOrBuilder getChecksumsOrBuilder()

Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests.

.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ObjectChecksumsOrBuilder`

getComponentCount()

public int getComponentCount()

Output only. Number of underlying components that make up this object. Components are accumulated by compose operations. Attempting to set or update this field will result in a FieldViolation.

int32 component_count = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`int`	The componentCount.

getContentDisposition()

public String getContentDisposition()

Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266.

string content_disposition = 8;

Returns

Type	Description
`String`	The contentDisposition.

getContentDispositionBytes()

public ByteString getContentDispositionBytes()

Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266.

string content_disposition = 8;

Returns

Type	Description
`ByteString`	The bytes for contentDisposition.

getContentEncoding()

public String getContentEncoding()

Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2

string content_encoding = 7;

Returns

Type	Description
`String`	The contentEncoding.

getContentEncodingBytes()

public ByteString getContentEncodingBytes()

Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2

string content_encoding = 7;

Returns

Type	Description
`ByteString`	The bytes for contentEncoding.

getContentLanguage()

public String getContentLanguage()

Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2.

string content_language = 11;

Returns

Type	Description
`String`	The contentLanguage.

getContentLanguageBytes()

public ByteString getContentLanguageBytes()

Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2.

string content_language = 11;

Returns

Type	Description
`ByteString`	The bytes for contentLanguage.

getContentType()

public String getContentType()

Content-Type of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.1.5. If an object is stored without a Content-Type, it is served as application/octet-stream.

string content_type = 13;

Returns

Type	Description
`String`	The contentType.

getContentTypeBytes()

public ByteString getContentTypeBytes()

Content-Type of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.1.5. If an object is stored without a Content-Type, it is served as application/octet-stream.

string content_type = 13;

Returns

Type	Description
`ByteString`	The bytes for contentType.

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time of the object. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the object. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getCustomTime()

public Timestamp getCustomTime()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns

Type	Description
`Timestamp`	The customTime.

getCustomTimeOrBuilder()

public TimestampOrBuilder getCustomTimeOrBuilder()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns

Type	Description
`TimestampOrBuilder`

getCustomerEncryption()

public CustomerEncryption getCustomerEncryption()

Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.

.google.storage.v2.CustomerEncryption customer_encryption = 25;

Returns

Type	Description
`CustomerEncryption`	The customerEncryption.

getCustomerEncryptionOrBuilder()

public CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()

Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.

.google.storage.v2.CustomerEncryption customer_encryption = 25;

Returns

Type	Description
`CustomerEncryptionOrBuilder`

getDefaultInstanceForType()

public Object getDefaultInstanceForType()

Returns

Type	Description
`Object`

getDeleteTime()

public Timestamp getDeleteTime()

Output only. The deletion time of the object. Will be returned if and only if this version of the object has been deleted. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The deleteTime.

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The deletion time of the object. Will be returned if and only if this version of the object has been deleted. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getEtag()

public String getEtag()

The etag of the object. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object.

string etag = 27;

Returns

Type	Description
`String`	The etag.

getEtagBytes()

public ByteString getEtagBytes()

The etag of the object. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object.

string etag = 27;

Returns

Type	Description
`ByteString`	The bytes for etag.

getEventBasedHold()

public boolean getEventBasedHold()

Whether an object is under event-based hold. An event-based hold is a way to force the retention of an object until after some event occurs. Once the hold is released by explicitly setting this field to false, the object will become subject to any bucket-level retention policy, except that the retention duration will be calculated from the time the event based hold was lifted, rather than the time the object was created. In a WriteObject request, not setting this field implies that the value should be taken from the parent bucket's "default_event_based_hold" field. In a response, this field will always be set to true or false.

optional bool event_based_hold = 23;

Returns

Type	Description
`boolean`	The eventBasedHold.

getGeneration()

public long getGeneration()

Immutable. The content generation of this object. Used for object versioning. Attempting to set or update this field will result in a FieldViolation.

int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`long`	The generation.

getKmsKey()

public String getKmsKey()

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

string kms_key = 18 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
`String`	The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

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

string kms_key = 18 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
`ByteString`	The bytes for kmsKey.

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns

Type	Description
`Map<String,String>`

getMetadataCount()

public int getMetadataCount()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Returns

Type	Description
`int`

getMetadataMap()

public Map<String,String> getMetadataMap()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Returns

Type	Description
`Map<String,String>`

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getMetageneration()

public long getMetageneration()

Output only. The version of the metadata for this generation of this object. 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. Attempting to set or update this field will result in a FieldViolation.

int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`long`	The metageneration.

getName()

public String getName()

Immutable. The name of this object. Nearly any sequence of unicode characters is valid. See Guidelines. Example: test.txt The name field by itself does not uniquely identify a Cloud Storage object. A Cloud Storage object is uniquely identified by the tuple of (bucket, object, generation).

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`ByteString`	The bytes for name.

getOwner()

public Owner getOwner()

Output only. The owner of the object. This will always be the uploader of the object. Attempting to set or update this field will result in a FieldViolation.

.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Owner`	The owner.

getOwnerOrBuilder()

public OwnerOrBuilder getOwnerOrBuilder()

Output only. The owner of the object. This will always be the uploader of the object. Attempting to set or update this field will result in a FieldViolation.

.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`OwnerOrBuilder`

getParserForType()

public Parser<Object> getParserForType()

Returns

Type	Description
`Parser<Object>`

Overrides

GeneratedMessageV3.getParserForType()

getRetentionExpireTime()

public Timestamp getRetentionExpireTime()

A server-determined value that specifies the earliest time that the object's retention period expires. 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 temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

.google.protobuf.Timestamp retention_expire_time = 21;

Returns

Type	Description
`Timestamp`	The retentionExpireTime.

getRetentionExpireTimeOrBuilder()

public TimestampOrBuilder getRetentionExpireTimeOrBuilder()

.google.protobuf.Timestamp retention_expire_time = 21;

Returns

Type	Description
`TimestampOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSize()

public long getSize()

Output only. Content-Length of the object data in bytes, matching https://tools.ietf.org/html/rfc7230#section-3.3.2. Attempting to set or update this field will result in a FieldViolation.

int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`long`	The size.

getStorageClass()

public String getStorageClass()

Storage class of the object.

string storage_class = 5;

Returns

Type	Description
`String`	The storageClass.

getStorageClassBytes()

public ByteString getStorageClassBytes()

Storage class of the object.

string storage_class = 5;

Returns

Type	Description
`ByteString`	The bytes for storageClass.

getTemporaryHold()

public boolean getTemporaryHold()

Whether an object is under temporary hold. While this flag 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. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.

bool temporary_hold = 20;

Returns

Type	Description
`boolean`	The temporaryHold.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

getUpdateStorageClassTime()

public Timestamp getUpdateStorageClassTime()

Output only. The time at which the object's storage class was last changed. When the object is initially created, it will be set to time_created. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The updateStorageClassTime.

getUpdateStorageClassTimeOrBuilder()

public TimestampOrBuilder getUpdateStorageClassTimeOrBuilder()

.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The modification time of the object metadata. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

hasChecksums()

public boolean hasChecksums()

Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests.

.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the checksums field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation time of the object. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the createTime field is set.

hasCustomTime()

public boolean hasCustomTime()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns

Type	Description
`boolean`	Whether the customTime field is set.

hasCustomerEncryption()

public boolean hasCustomerEncryption()

Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.

.google.storage.v2.CustomerEncryption customer_encryption = 25;

Returns

Type	Description
`boolean`	Whether the customerEncryption field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. The deletion time of the object. Will be returned if and only if this version of the object has been deleted. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the deleteTime field is set.

hasEventBasedHold()

public boolean hasEventBasedHold()

optional bool event_based_hold = 23;

Returns

Type	Description
`boolean`	Whether the eventBasedHold field is set.

hasOwner()

public boolean hasOwner()

Output only. The owner of the object. This will always be the uploader of the object. Attempting to set or update this field will result in a FieldViolation.

.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the owner field is set.

hasRetentionExpireTime()

public boolean hasRetentionExpireTime()

.google.protobuf.Timestamp retention_expire_time = 21;

Returns

Type	Description
`boolean`	Whether the retentionExpireTime field is set.

hasUpdateStorageClassTime()

public boolean hasUpdateStorageClassTime()

.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the updateStorageClassTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns

Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Object.Builder newBuilderForType()

Returns

Type	Description
`Object.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Object.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
`parent`	`BuilderParent`

Returns

Type	Description
`Object.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
`unused`	`UnusedPrivateParameter`

Returns

Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Object.Builder toBuilder()

Returns

Type	Description
`Object.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
`IOException`