- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.3
- 2.52.3
- 2.50.0
- 2.49.0
- 2.48.2
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.1
- 2.43.2
- 2.42.0
- 2.41.0
- 2.40.1
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.1
- 2.34.0
- 2.33.0
- 2.32.1
- 2.30.1
- 2.29.1
- 2.28.0
- 2.27.1
- 2.24.0
- 2.23.0
- 2.22.6
- 2.21.0
- 2.20.2
- 2.19.0
- 2.18.0
- 2.17.2
- 2.16.0
- 2.15.1
- 2.14.0
- 2.13.1
- 2.12.0
- 2.11.3
- 2.10.0
- 2.9.3
- 2.8.1
- 2.7.1
- 2.6.1
- 2.5.1
- 2.4.5
- 2.3.0
- 2.2.3
- 2.1.10
public interface ObjectOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsMetadata(String key)
public abstract 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 abstract ObjectAccessControl getAcl(int index)Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl acl = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ObjectAccessControl |
|
getAclCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ObjectChecksums getChecksums()Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests. The checksums of the complete object regardless of data range. If the object is downloaded in full, the client should compute one of these checksums over the downloaded object and compare it against the value provided here.
.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ObjectChecksums |
The checksums. |
getChecksumsOrBuilder()
public abstract ObjectChecksumsOrBuilder getChecksumsOrBuilder()Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests. The checksums of the complete object regardless of data range. If the object is downloaded in full, the client should compute one of these checksums over the downloaded object and compare it against the value provided here.
.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ObjectChecksumsOrBuilder |
|
getComponentCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Timestamp getCreateTime()Output only. The creation time of the object.
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract 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 abstract Timestamp getCustomTime()A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The customTime. |
getCustomTimeOrBuilder()
public abstract TimestampOrBuilder getCustomTimeOrBuilder()A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCustomerEncryption()
public abstract CustomerEncryption getCustomerEncryption()Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;
| Returns | |
|---|---|
| Type | Description |
CustomerEncryption |
The customerEncryption. |
getCustomerEncryptionOrBuilder()
public abstract 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 |
|
getDeleteTime()
public abstract Timestamp getDeleteTime()Output only. If this object is noncurrent, this is the time when the object became noncurrent.
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The deleteTime. |
getDeleteTimeOrBuilder()
public abstract TimestampOrBuilder getDeleteTimeOrBuilder()Output only. If this object is noncurrent, this is the time when the object became noncurrent.
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getEtag()
public abstract 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 abstract 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 abstract 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 abstract long getGeneration()Immutable. The content generation of this object. Used for object versioning.
int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
long |
The generation. |
getHardDeleteTime()
public abstract Timestamp getHardDeleteTime()Output only. The time when the object will be permanently deleted.
Only set when an object becomes soft-deleted with a soft_delete_policy. Otherwise, the object will not be accessible.
optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The hardDeleteTime. |
getHardDeleteTimeOrBuilder()
public abstract TimestampOrBuilder getHardDeleteTimeOrBuilder()Output only. The time when the object will be permanently deleted.
Only set when an object becomes soft-deleted with a soft_delete_policy. Otherwise, the object will not be accessible.
optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getKmsKey()
public abstract 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 abstract ByteString getKmsKeyBytes()Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
string kms_key = 18 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for kmsKey. |
getMetadata() (deprecated)
public abstract Map<String,String> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataCount()
public abstract int getMetadataCount()User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetadataMap()
public abstract 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 abstract 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 abstract 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 abstract long getMetageneration()Output only. The version of the metadata for this generation of this object. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The metageneration. |
getName()
public abstract 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 abstract 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 abstract Owner getOwner()Output only. The owner of the object. This will always be the uploader of the object.
.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Owner |
The owner. |
getOwnerOrBuilder()
public abstract 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 |
| |