public final class Object extends com.google.protobuf.GeneratedMessageV3 implements ObjectOrBuilder
An object.Protobuf type
google.storage.v2.Object| Modifier and Type | Class and Description |
|---|---|
static class |
Object.Builder
An object.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
containsMetadata(String key)
User-provided metadata, in key/value pairs.
|
boolean |
equals(Object obj) |
ObjectAccessControl |
getAcl(int index)
Access controls on the object.
|
int |
getAclCount()
Access controls on the object.
|
List<ObjectAccessControl> |
getAclList()
Access controls on the object.
|
ObjectAccessControlOrBuilder |
getAclOrBuilder(int index)
Access controls on the object.
|
List<? extends ObjectAccessControlOrBuilder> |
getAclOrBuilderList()
Access controls on the object.
|
String |
getBucket()
Immutable.
|
com.google.protobuf.ByteString |
getBucketBytes()
Immutable.
|
String |
getCacheControl()
Cache-Control directive for the object data, matching
[https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
|
com.google.protobuf.ByteString |
getCacheControlBytes()
Cache-Control directive for the object data, matching
[https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
|
ObjectChecksums |
getChecksums()
Output only.
|
ObjectChecksumsOrBuilder |
getChecksumsOrBuilder()
Output only.
|
int |
getComponentCount()
Output only.
|
String |
getContentDisposition()
Content-Disposition of the object data, matching
[https://tools.ietf.org/html/rfc6266][RFC 6266].
|
com.google.protobuf.ByteString |
getContentDispositionBytes()
Content-Disposition of the object data, matching
[https://tools.ietf.org/html/rfc6266][RFC 6266].
|
String |
getContentEncoding()
Content-Encoding of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
|
com.google.protobuf.ByteString |
getContentEncodingBytes()
Content-Encoding of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
|
String |
getContentLanguage()
Content-Language of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
|
com.google.protobuf.ByteString |
getContentLanguageBytes()
Content-Language of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
|
String |
getContentType()
Content-Type of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
|
com.google.protobuf.ByteString |
getContentTypeBytes()
Content-Type of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
CustomerEncryption |
getCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
such a key.
|
CustomerEncryptionOrBuilder |
getCustomerEncryptionOrBuilder()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
such a key.
|
com.google.protobuf.Timestamp |
getCustomTime()
A user-specified timestamp set on an object.
|
com.google.protobuf.TimestampOrBuilder |
getCustomTimeOrBuilder()
A user-specified timestamp set on an object.
|
static Object |
getDefaultInstance() |
Object |
getDefaultInstanceForType() |
com.google.protobuf.Timestamp |
getDeleteTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getDeleteTimeOrBuilder()
Output only.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEtag()
The etag of the object.
|
com.google.protobuf.ByteString |
getEtagBytes()
The etag of the object.
|
boolean |
getEventBasedHold()
Whether an object is under event-based hold.
|
long |
getGeneration()
Immutable.
|
String |
getKmsKey()
Cloud KMS Key used to encrypt this object, if the object is encrypted by
such a key.
|
com.google.protobuf.ByteString |
getKmsKeyBytes()
Cloud KMS Key used to encrypt this object, if the object is encrypted by
such a key.
|
Map<String,String> |
getMetadata()
Deprecated.
|
int |
getMetadataCount()
User-provided metadata, in key/value pairs.
|
Map<String,String> |
getMetadataMap()
User-provided metadata, in key/value pairs.
|
String |
getMetadataOrDefault(String key,
String defaultValue)
User-provided metadata, in key/value pairs.
|
String |
getMetadataOrThrow(String key)
User-provided metadata, in key/value pairs.
|
long |
getMetageneration()
Output only.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
Owner |
getOwner()
Output only.
|
OwnerOrBuilder |
getOwnerOrBuilder()
Output only.
|
com.google.protobuf.Parser<Object> |
getParserForType() |
com.google.protobuf.Timestamp |
getRetentionExpireTime()
A server-determined value that specifies the earliest time that the
object's retention period expires.
|
com.google.protobuf.TimestampOrBuilder |
getRetentionExpireTimeOrBuilder()
A server-determined value that specifies the earliest time that the
object's retention period expires.
|
int |
getSerializedSize() |
long |
getSize()
Output only.
|
String |
getStorageClass()
Storage class of the object.
|
com.google.protobuf.ByteString |
getStorageClassBytes()
Storage class of the object.
|
boolean |
getTemporaryHold()
Whether an object is under temporary hold.
|
com.google.protobuf.Timestamp |
getUpdateStorageClassTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateStorageClassTimeOrBuilder()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasChecksums()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
such a key.
|
boolean |
hasCustomTime()
A user-specified timestamp set on an object.
|
boolean |
hasDeleteTime()
Output only.
|
boolean |
hasEventBasedHold()
Whether an object is under event-based hold.
|
int |
hashCode() |
boolean |
hasOwner()
Output only.
|
boolean |
hasRetentionExpireTime()
A server-determined value that specifies the earliest time that the
object's retention period expires.
|
boolean |
hasUpdateStorageClassTime()
Output only.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Object.Builder |
newBuilder() |
static Object.Builder |
newBuilder(Object prototype) |
Object.Builder |
newBuilderForType() |
protected Object.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Object |
parseDelimitedFrom(InputStream input) |
static Object |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Object |
parseFrom(byte[] data) |
static Object |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Object |
parseFrom(ByteBuffer data) |
static Object |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Object |
parseFrom(com.google.protobuf.ByteString data) |
static Object |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Object |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Object |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Object |
parseFrom(InputStream input) |
static Object |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Object> |
parser() |
Object.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int BUCKET_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int GENERATION_FIELD_NUMBER
public static final int METAGENERATION_FIELD_NUMBER
public static final int STORAGE_CLASS_FIELD_NUMBER
public static final int SIZE_FIELD_NUMBER
public static final int CONTENT_ENCODING_FIELD_NUMBER
public static final int CONTENT_DISPOSITION_FIELD_NUMBER
public static final int CACHE_CONTROL_FIELD_NUMBER
public static final int ACL_FIELD_NUMBER
public static final int CONTENT_LANGUAGE_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
public static final int CONTENT_TYPE_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int COMPONENT_COUNT_FIELD_NUMBER
public static final int CHECKSUMS_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER
public static final int UPDATE_STORAGE_CLASS_TIME_FIELD_NUMBER
public static final int TEMPORARY_HOLD_FIELD_NUMBER
public static final int RETENTION_EXPIRE_TIME_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int EVENT_BASED_HOLD_FIELD_NUMBER
public static final int OWNER_FIELD_NUMBER
public static final int CUSTOMER_ENCRYPTION_FIELD_NUMBER
public static final int CUSTOM_TIME_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Immutable. The name of this object. Nearly any sequence of unicode characters is valid. See [Guidelines](https://cloud.google.com/storage/docs/objects#naming). 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];getName in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Immutable. The name of this object. Nearly any sequence of unicode characters is valid. See [Guidelines](https://cloud.google.com/storage/docs/objects#naming). 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];getNameBytes in interface ObjectOrBuilderpublic String getBucket()
Immutable. The name of the bucket containing this object.
string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
getBucket in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getBucketBytes()
Immutable. The name of the bucket containing this object.
string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
getBucketBytes in interface ObjectOrBuilderpublic 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;getEtag in interface ObjectOrBuilderpublic com.google.protobuf.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;getEtagBytes in interface ObjectOrBuilderpublic 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][google.rpc.BadRequest.FieldViolation].
int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];getGeneration in interface ObjectOrBuilderpublic 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][google.rpc.BadRequest.FieldViolation].
int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];getMetageneration in interface ObjectOrBuilderpublic String getStorageClass()
Storage class of the object.
string storage_class = 5;getStorageClass in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getStorageClassBytes()
Storage class of the object.
string storage_class = 5;getStorageClassBytes in interface ObjectOrBuilderpublic long getSize()
Output only. Content-Length of the object data in bytes, matching [https://tools.ietf.org/html/rfc7230#section-3.3.2][RFC 7230 §3.3.2]. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];getSize in interface ObjectOrBuilderpublic String getContentEncoding()
Content-Encoding of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
string content_encoding = 7;getContentEncoding in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getContentEncodingBytes()
Content-Encoding of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
string content_encoding = 7;getContentEncodingBytes in interface ObjectOrBuilderpublic String getContentDisposition()
Content-Disposition of the object data, matching [https://tools.ietf.org/html/rfc6266][RFC 6266].
string content_disposition = 8;getContentDisposition in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getContentDispositionBytes()
Content-Disposition of the object data, matching [https://tools.ietf.org/html/rfc6266][RFC 6266].
string content_disposition = 8;getContentDispositionBytes in interface ObjectOrBuilderpublic String getCacheControl()
Cache-Control directive for the object data, matching [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §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;getCacheControl in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getCacheControlBytes()
Cache-Control directive for the object data, matching [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §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;getCacheControlBytes in interface ObjectOrBuilderpublic 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;getAclList in interface ObjectOrBuilderpublic 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;getAclOrBuilderList in interface ObjectOrBuilderpublic 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;getAclCount in interface ObjectOrBuilderpublic 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;getAcl in interface ObjectOrBuilderpublic 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;getAclOrBuilder in interface ObjectOrBuilderpublic String getContentLanguage()
Content-Language of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
string content_language = 11;getContentLanguage in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getContentLanguageBytes()
Content-Language of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
string content_language = 11;getContentLanguageBytes in interface ObjectOrBuilderpublic boolean hasDeleteTime()
Output only. If this object is noncurrent, this is the time when the object became noncurrent. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasDeleteTime in interface ObjectOrBuilderpublic com.google.protobuf.Timestamp getDeleteTime()
Output only. If this object is noncurrent, this is the time when the object became noncurrent. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeleteTime in interface ObjectOrBuilderpublic com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. If this object is noncurrent, this is the time when the object became noncurrent. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeleteTimeOrBuilder in interface ObjectOrBuilderpublic String getContentType()
Content-Type of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5]. If an object is stored without a Content-Type, it is served as `application/octet-stream`.
string content_type = 13;getContentType in interface ObjectOrBuilderpublic com.google.protobuf.ByteString getContentTypeBytes()
Content-Type of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5]. If an object is stored without a Content-Type, it is served as `application/octet-stream`.
string content_type = 13;getContentTypeBytes in interface ObjectOrBuilderpublic boolean hasCreateTime()
Output only. The creation time of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface ObjectOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. The creation time of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface ObjectOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface ObjectOrBuilderpublic 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][google.rpc.BadRequest.FieldViolation].
int32 component_count = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];getComponentCount in interface ObjectOrBuilderpublic 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];
hasChecksums in interface ObjectOrBuilderpublic 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];
getChecksums in interface ObjectOrBuilderpublic 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];
getChecksumsOrBuilder in interface ObjectOrBuilderpublic 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. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface ObjectOrBuilderpublic com.google.protobuf.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.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface ObjectOrBuilderpublic com.google.protobuf.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. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface ObjectOrBuilderpublic 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) = { ... }getKmsKey in interface ObjectOrBuilderpublic com.google.protobuf.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) = { ... }getKmsKeyBytes in interface ObjectOrBuilderpublic 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. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateStorageClassTime in interface ObjectOrBuilderpublic com.google.protobuf.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.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateStorageClassTime in interface ObjectOrBuilderpublic com.google.protobuf.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. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateStorageClassTimeOrBuilder in interface ObjectOrBuilderpublic 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;getTemporaryHold in interface ObjectOrBuilderpublic 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;hasRetentionExpireTime in interface ObjectOrBuilderpublic com.google.protobuf.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;getRetentionExpireTime in interface ObjectOrBuilderpublic com.google.protobuf.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;getRetentionExpireTimeOrBuilder in interface ObjectOrBuilderpublic int getMetadataCount()
ObjectOrBuilderUser-provided metadata, in key/value pairs.
map<string, string> metadata = 22;getMetadataCount in interface ObjectOrBuilderpublic boolean containsMetadata(String key)
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;containsMetadata in interface ObjectOrBuilder@Deprecated public Map<String,String> getMetadata()
getMetadataMap() instead.getMetadata in interface ObjectOrBuilderpublic Map<String,String> getMetadataMap()
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;getMetadataMap in interface ObjectOrBuilderpublic String getMetadataOrDefault(String key, String defaultValue)
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;getMetadataOrDefault in interface ObjectOrBuilderpublic String getMetadataOrThrow(String key)
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;getMetadataOrThrow in interface ObjectOrBuilderpublic 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;hasEventBasedHold in interface ObjectOrBuilderpublic 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;getEventBasedHold in interface ObjectOrBuilderpublic 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.rpc.BadRequest.FieldViolation].
.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];hasOwner in interface ObjectOrBuilderpublic 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.rpc.BadRequest.FieldViolation].
.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];getOwner in interface ObjectOrBuilderpublic 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.rpc.BadRequest.FieldViolation].
.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];getOwnerOrBuilder in interface ObjectOrBuilderpublic boolean hasCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;hasCustomerEncryption in interface ObjectOrBuilderpublic CustomerEncryption getCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;getCustomerEncryption in interface ObjectOrBuilderpublic CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;getCustomerEncryptionOrBuilder in interface ObjectOrBuilderpublic boolean hasCustomTime()
A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;hasCustomTime in interface ObjectOrBuilderpublic com.google.protobuf.Timestamp getCustomTime()
A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;getCustomTime in interface ObjectOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCustomTimeOrBuilder()
A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;getCustomTimeOrBuilder in interface ObjectOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Object parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Object parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Object parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Object parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Object parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Object parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Object parseFrom(InputStream input) throws IOException
IOExceptionpublic static Object parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Object parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Object parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Object parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Object parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Object.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Object.Builder newBuilder()
public static Object.Builder newBuilder(Object prototype)
public Object.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Object.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Object getDefaultInstance()
public static com.google.protobuf.Parser<Object> parser()
public com.google.protobuf.Parser<Object> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Object getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.