public static final class Object.Builder extends GeneratedMessageV3.Builder<Object.Builder> implements ObjectOrBuilderAn object.
Protobuf type google.storage.v2.Object
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Object.BuilderImplements
ObjectOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAcl(ObjectAccessControl value)
public Object.Builder addAcl(ObjectAccessControl value)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 |
value |
ObjectAccessControl |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
addAcl(ObjectAccessControl.Builder builderForValue)
public Object.Builder addAcl(ObjectAccessControl.Builder builderForValue)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 |
builderForValue |
ObjectAccessControl.Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
addAcl(int index, ObjectAccessControl value)
public Object.Builder addAcl(int index, ObjectAccessControl value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ObjectAccessControl |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
addAcl(int index, ObjectAccessControl.Builder builderForValue)
public Object.Builder addAcl(int index, ObjectAccessControl.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ObjectAccessControl.Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
addAclBuilder()
public ObjectAccessControl.Builder addAclBuilder()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 |
ObjectAccessControl.Builder |
|
addAclBuilder(int index)
public ObjectAccessControl.Builder addAclBuilder(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.Builder |
|
addAllAcl(Iterable<? extends ObjectAccessControl> values)
public Object.Builder addAllAcl(Iterable<? extends ObjectAccessControl> values)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 |
values |
Iterable<? extends com.google.storage.v2.ObjectAccessControl> |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Object.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
build()
public Object build()| Returns | |
|---|---|
| Type | Description |
Object |
|
buildPartial()
public Object buildPartial()| Returns | |
|---|---|
| Type | Description |
Object |
|
clear()
public Object.Builder clear()| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
clearAcl()
public Object.Builder clearAcl()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 |
Object.Builder |
|
clearBucket()
public Object.Builder clearBucket()Immutable. The name of the bucket containing this object.
string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
clearCacheControl()
public Object.Builder clearCacheControl() 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 |
Object.Builder |
This builder for chaining. |
clearChecksums()
public Object.Builder clearChecksums()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 |
Object.Builder |
|
clearComponentCount()
public Object.Builder clearComponentCount()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 |
Object.Builder |
This builder for chaining. |
clearContentDisposition()
public Object.Builder clearContentDisposition()Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266.
string content_disposition = 8;
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
clearContentEncoding()
public Object.Builder clearContentEncoding()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 |
Object.Builder |
This builder for chaining. |
clearContentLanguage()
public Object.Builder clearContentLanguage()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 |
Object.Builder |
This builder for chaining. |
clearContentType()
public Object.Builder clearContentType() 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 |
Object.Builder |
This builder for chaining. |
clearCreateTime()
public Object.Builder clearCreateTime()Output only. The creation time of the object.
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
clearCustomTime()
public Object.Builder clearCustomTime()A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
clearCustomerEncryption()
public Object.Builder clearCustomerEncryption()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 |
Object.Builder |
|
clearDeleteTime()
public Object.Builder clearDeleteTime()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 |
Object.Builder |
|
clearEtag()
public Object.Builder clearEtag()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 |
Object.Builder |
This builder for chaining. |
clearEventBasedHold()
public Object.Builder clearEventBasedHold()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 |
Object.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Object.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
clearGeneration()
public Object.Builder clearGeneration()Immutable. The content generation of this object. Used for object versioning.
int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
clearKmsKey()
public Object.Builder clearKmsKey()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 |
Object.Builder |
This builder for chaining. |
clearMetadata()
public Object.Builder clearMetadata()| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
clearMetageneration()
public Object.Builder clearMetageneration()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 |
Object.Builder |
This builder for chaining. |
clearName()
public Object.Builder clearName() 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 |
Object.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Object.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
clearOwner()
public Object.Builder clearOwner()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 |
Object.Builder |
|
clearRetentionExpireTime()
public Object.Builder clearRetentionExpireTime()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 |
Object.Builder |
|
clearSize()
public Object.Builder clearSize()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 |
Object.Builder |
This builder for chaining. |
clearStorageClass()
public Object.Builder clearStorageClass()Storage class of the object.
string storage_class = 5;
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
clearTemporaryHold()
public Object.Builder clearTemporaryHold()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 |
Object.Builder |
This builder for chaining. |
clearUpdateStorageClassTime()
public Object.Builder clearUpdateStorageClassTime()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 |
Object.Builder |
|
clearUpdateTime()
public Object.Builder clearUpdateTime()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 |
Object.Builder |
|
clone()
public Object.Builder clone()| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
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 |
|
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 |
|
getAclBuilder(int index)
public ObjectAccessControl.Builder getAclBuilder(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.Builder |
|
getAclBuilderList()
public List<ObjectAccessControl.Builder> getAclBuilderList()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<Builder> |
|
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.
.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ObjectChecksums |
The checksums. |
getChecksumsBuilder()
public ObjectChecksums.Builder getChecksumsBuilder()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.Builder |
|
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.
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The creation time of the object.
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
getCustomTimeBuilder()
public Timestamp.Builder getCustomTimeBuilder()A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
getCustomerEncryptionBuilder()
public CustomerEncryption.Builder getCustomerEncryptionBuilder()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.Builder |
|
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. |
getDeleteTimeBuilder()
public Timestamp.Builder getDeleteTimeBuilder()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 |
Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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.
int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The metageneration. |
getMutableMetadata()
public Map<String,String> getMutableMetadata()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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. |
getOwnerBuilder()
public Owner.Builder getOwnerBuilder()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.Builder |
|
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 |
|
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. |
getRetentionExpireTimeBuilder()
public Timestamp.Builder getRetentionExpireTimeBuilder()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 |
Builder |
|
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 |
|
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. |
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. |
getUpdateStorageClassTimeBuilder()
public Timestamp.Builder getUpdateStorageClassTimeBuilder()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 |
Builder |
|
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder |
|
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.
.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. |
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. |
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. |
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 |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeChecksums(ObjectChecksums value)
public Object.Builder mergeChecksums(ObjectChecksums value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ObjectChecksums |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeCreateTime(Timestamp value)
public Object.Builder mergeCreateTime(Timestamp value)Output only. The creation time of the object.
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeCustomTime(Timestamp value)
public Object.Builder mergeCustomTime(Timestamp value)A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeCustomerEncryption(CustomerEncryption value)
public Object.Builder mergeCustomerEncryption(CustomerEncryption value)Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
CustomerEncryption |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeDeleteTime(Timestamp value)
public Object.Builder mergeDeleteTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Object.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Object.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeFrom(Object other)
public Object.Builder mergeFrom(Object other)| Parameter | |
|---|---|
| Name | Description |
other |
Object |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeOwner(Owner value)
public Object.Builder mergeOwner(Owner value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Owner |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeRetentionExpireTime(Timestamp value)
public Object.Builder mergeRetentionExpireTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Object.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeUpdateStorageClassTime(Timestamp value)
public Object.Builder mergeUpdateStorageClassTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
mergeUpdateTime(Timestamp value)
public Object.Builder mergeUpdateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
putAllMetadata(Map<String,String> values)
public Object.Builder putAllMetadata(Map<String,String> values)User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
putMetadata(String key, String value)
public Object.Builder putMetadata(String key, String value)User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
removeAcl(int index)
public Object.Builder removeAcl(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 |
Object.Builder |
|
removeMetadata(String key)
public Object.Builder removeMetadata(String key)User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setAcl(int index, ObjectAccessControl value)
public Object.Builder setAcl(int index, ObjectAccessControl value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ObjectAccessControl |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setAcl(int index, ObjectAccessControl.Builder builderForValue)
public Object.Builder setAcl(int index, ObjectAccessControl.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ObjectAccessControl.Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setBucket(String value)
public Object.Builder setBucket(String value)Immutable. The name of the bucket containing this object.
string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe bucket to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setBucketBytes(ByteString value)
public Object.Builder setBucketBytes(ByteString value)Immutable. The name of the bucket containing this object.
string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for bucket to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setCacheControl(String value)
public Object.Builder setCacheControl(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe cacheControl to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setCacheControlBytes(ByteString value)
public Object.Builder setCacheControlBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for cacheControl to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setChecksums(ObjectChecksums value)
public Object.Builder setChecksums(ObjectChecksums value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ObjectChecksums |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setChecksums(ObjectChecksums.Builder builderForValue)
public Object.Builder setChecksums(ObjectChecksums.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ObjectChecksums.Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setComponentCount(int value)
public Object.Builder setComponentCount(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe componentCount to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentDisposition(String value)
public Object.Builder setContentDisposition(String value)Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266.
string content_disposition = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe contentDisposition to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentDispositionBytes(ByteString value)
public Object.Builder setContentDispositionBytes(ByteString value)Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266.
string content_disposition = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for contentDisposition to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentEncoding(String value)
public Object.Builder setContentEncoding(String value)Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2
string content_encoding = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe contentEncoding to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentEncodingBytes(ByteString value)
public Object.Builder setContentEncodingBytes(ByteString value)Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2
string content_encoding = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for contentEncoding to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentLanguage(String value)
public Object.Builder setContentLanguage(String value)Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2.
string content_language = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe contentLanguage to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentLanguageBytes(ByteString value)
public Object.Builder setContentLanguageBytes(ByteString value)Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2.
string content_language = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for contentLanguage to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentType(String value)
public Object.Builder setContentType(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe contentType to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setContentTypeBytes(ByteString value)
public Object.Builder setContentTypeBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for contentType to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public Object.Builder setCreateTime(Timestamp value)Output only. The creation time of the object.
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Object.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The creation time of the object.
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setCustomTime(Timestamp value)
public Object.Builder setCustomTime(Timestamp value)A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setCustomTime(Timestamp.Builder builderForValue)
public Object.Builder setCustomTime(Timestamp.Builder builderForValue)A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setCustomerEncryption(CustomerEncryption value)
public Object.Builder setCustomerEncryption(CustomerEncryption value)Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
CustomerEncryption |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setCustomerEncryption(CustomerEncryption.Builder builderForValue)
public Object.Builder setCustomerEncryption(CustomerEncryption.Builder builderForValue)Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CustomerEncryption.Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setDeleteTime(Timestamp value)
public Object.Builder setDeleteTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setDeleteTime(Timestamp.Builder builderForValue)
public Object.Builder setDeleteTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setEtag(String value)
public Object.Builder setEtag(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public Object.Builder setEtagBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setEventBasedHold(boolean value)
public Object.Builder setEventBasedHold(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe eventBasedHold to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Object.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setGeneration(long value)
public Object.Builder setGeneration(long value)Immutable. The content generation of this object. Used for object versioning.
int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe generation to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setKmsKey(String value)
public Object.Builder setKmsKey(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe kmsKey to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setKmsKeyBytes(ByteString value)
public Object.Builder setKmsKeyBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for kmsKey to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setMetageneration(long value)
public Object.Builder setMetageneration(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe metageneration to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setName(String value)
public Object.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Object.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setOwner(Owner value)
public Object.Builder setOwner(Owner value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Owner |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setOwner(Owner.Builder builderForValue)
public Object.Builder setOwner(Owner.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Owner.Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Object.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setRetentionExpireTime(Timestamp value)
public Object.Builder setRetentionExpireTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setRetentionExpireTime(Timestamp.Builder builderForValue)
public Object.Builder setRetentionExpireTime(Timestamp.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setSize(long value)
public Object.Builder setSize(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe size to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setStorageClass(String value)
public Object.Builder setStorageClass(String value)Storage class of the object.
string storage_class = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe storageClass to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setStorageClassBytes(ByteString value)
public Object.Builder setStorageClassBytes(ByteString value)Storage class of the object.
string storage_class = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for storageClass to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setTemporaryHold(boolean value)
public Object.Builder setTemporaryHold(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe temporaryHold to set. |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Object.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setUpdateStorageClassTime(Timestamp value)
public Object.Builder setUpdateStorageClassTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setUpdateStorageClassTime(Timestamp.Builder builderForValue)
public Object.Builder setUpdateStorageClassTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setUpdateTime(Timestamp value)
public Object.Builder setUpdateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Object.Builder setUpdateTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Object.Builder |
|