public interface GetObjectRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBucket()
public abstract String getBucket()Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The bucket. |
getBucketBytes()
public abstract ByteString getBucketBytes()Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for bucket. |
getCommonObjectRequestParams()
public abstract CommonObjectRequestParams getCommonObjectRequestParams()A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
| Returns | |
|---|---|
| Type | Description |
CommonObjectRequestParams |
The commonObjectRequestParams. |
getCommonObjectRequestParamsOrBuilder()
public abstract CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
| Returns | |
|---|---|
| Type | Description |
CommonObjectRequestParamsOrBuilder |
|
getGeneration()
public abstract long getGeneration()If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
| Returns | |
|---|---|
| Type | Description |
long |
The generation. |
getIfGenerationMatch()
public abstract long getIfGenerationMatch()Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
optional int64 if_generation_match = 4;
| Returns | |
|---|---|
| Type | Description |
long |
The ifGenerationMatch. |
getIfGenerationNotMatch()
public abstract long getIfGenerationNotMatch()Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
optional int64 if_generation_not_match = 5;
| Returns | |
|---|---|
| Type | Description |
long |
The ifGenerationNotMatch. |
getIfMetagenerationMatch()
public abstract long getIfMetagenerationMatch()Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 6;
| Returns | |
|---|---|
| Type | Description |
long |
The ifMetagenerationMatch. |
getIfMetagenerationNotMatch()
public abstract long getIfMetagenerationNotMatch()Makes the operation conditional on whether the object's current metageneration does not match the given value.
optional int64 if_metageneration_not_match = 7;
| Returns | |
|---|---|
| Type | Description |
long |
The ifMetagenerationNotMatch. |
getObject()
public abstract String getObject()Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The object. |
getObjectBytes()
public abstract ByteString getObjectBytes()Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for object. |
getReadMask()
public abstract FieldMask getReadMask()Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 10;
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The readMask. |
getReadMaskOrBuilder()
public abstract FieldMaskOrBuilder getReadMaskOrBuilder()Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 10;
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
getSoftDeleted()
public abstract boolean getSoftDeleted()If true, return the soft-deleted version of this object.
optional bool soft_deleted = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
The softDeleted. |
hasCommonObjectRequestParams()
public abstract boolean hasCommonObjectRequestParams()A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the commonObjectRequestParams field is set. |
hasIfGenerationMatch()
public abstract boolean hasIfGenerationMatch()Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
optional int64 if_generation_match = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ifGenerationMatch field is set. |
hasIfGenerationNotMatch()
public abstract boolean hasIfGenerationNotMatch()Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
optional int64 if_generation_not_match = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ifGenerationNotMatch field is set. |
hasIfMetagenerationMatch()
public abstract boolean hasIfMetagenerationMatch()Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ifMetagenerationMatch field is set. |
hasIfMetagenerationNotMatch()
public abstract boolean hasIfMetagenerationNotMatch()Makes the operation conditional on whether the object's current metageneration does not match the given value.
optional int64 if_metageneration_not_match = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ifMetagenerationNotMatch field is set. |
hasReadMask()
public abstract boolean hasReadMask()Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the readMask field is set. |
hasSoftDeleted()
public abstract boolean hasSoftDeleted()If true, return the soft-deleted version of this object.
optional bool soft_deleted = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the softDeleted field is set. |