public final class Object extends GeneratedMessageV3 implements ObjectOrBuilderAn object.
Protobuf type google.storage.v2.Object
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ObjectImplements
ObjectOrBuilderStatic 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 |
|
HARD_DELETE_TIME_FIELD_NUMBER
public static final int HARD_DELETE_TIME_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 |
|
SOFT_DELETE_TIME_FIELD_NUMBER
public static final int SOFT_DELETE_TIME_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 |
|
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() 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 |
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. The checksums of the complete object regardless of data range. If the object is downloaded in full, the client should compute one of these checksums over the downloaded object and compare it against the value provided here.
.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. The checksums of the complete object regardless of data range. If the object is downloaded in full, the client should compute one of these checksums over the downloaded object and compare it against the value provided here.
.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.
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.
.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.
.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. If this object is noncurrent, this is the time when the object became noncurrent.
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The deleteTime. |
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()Output only. If this object is noncurrent, this is the time when the object became noncurrent.
.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.
int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
long |
The generation. |
getHardDeleteTime()
public Timestamp getHardDeleteTime()Output only. The time when the object will be permanently deleted.
Only set when an object becomes soft-deleted with a soft_delete_policy. Otherwise, the object will not be accessible.
optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The hardDeleteTime. |
getHardDeleteTimeOrBuilder()
public TimestampOrBuilder getHardDeleteTimeOrBuilder()Output only. The time when the object will be permanently deleted.
Only set when an object becomes soft-deleted with a soft_delete_policy. Otherwise, the object will not be accessible.
optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
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() (deprecated)
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.
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() 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 |
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.
.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.
.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> |
|
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()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 |
TimestampOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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.
int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The size. |
getSoftDeleteTime()
public Timestamp getSoftDeleteTime()Output only. This is the time when the object became soft-deleted.
Soft-deleted objects are only accessible if a soft_delete_policy is enabled. Also see hard_delete_time.
optional .google.protobuf.Timestamp soft_delete_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The softDeleteTime. |
getSoftDeleteTimeOrBuilder()
public TimestampOrBuilder getSoftDeleteTimeOrBuilder()Output only. This is the time when the object became soft-deleted.
Soft-deleted objects are only accessible if a soft_delete_policy is enabled. Also see hard_delete_time.
optional .google.protobuf.Timestamp soft_delete_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
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. |
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.
.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateStorageClassTime. |
getUpdateStorageClassTimeOrBuilder()
public TimestampOrBuilder getUpdateStorageClassTimeOrBuilder()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.
.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.
.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()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.
.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. The checksums of the complete object regardless of data range. If the object is downloaded in full, the client should compute one of these checksums over the downloaded object and compare it against the value provided here.
.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.
.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. If this object is noncurrent, this is the time when the object became noncurrent.
.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()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 |
Whether the eventBasedHold field is set. |
hasHardDeleteTime()
public boolean hasHardDeleteTime()Output only. The time when the object will be permanently deleted.
Only set when an object becomes soft-deleted with a soft_delete_policy. Otherwise, the object will not be accessible.
optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the hardDeleteTime field is set. |
hasOwner()
public boolean hasOwner()Output only. The owner of the object. This will always be the uploader of the object.
.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()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 |
boolean |
Whether the retentionExpireTime field is set. |
hasSoftDeleteTime()
public boolean hasSoftDeleteTime()Output only. This is the time when the object became soft-deleted.
Soft-deleted objects are only accessible if a soft_delete_policy is enabled. Also see hard_delete_time.
optional .google.protobuf.Timestamp soft_delete_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the softDeleteTime field is set. |
hasUpdateStorageClassTime()
public boolean hasUpdateStorageClassTime()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.
.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()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.
.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 |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Object.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|