public interface ReadObjectRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBucket()
public abstract String getBucket()Required. The name of the bucket containing the object to read.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The bucket. |
getBucketBytes()
public abstract ByteString getBucketBytes()Required. The name of the bucket containing the object to read.
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 = 10;
| 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 = 10;
| 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 = 6;
| 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 = 7;
| 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 = 8;
| 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 = 9;
| Returns | |
|---|---|
| Type | Description |
long |
The ifMetagenerationNotMatch. |
getObject()
public abstract String getObject()Required. The name of the object to read.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The object. |
getObjectBytes()
public abstract ByteString getObjectBytes()Required. The name of the object to read.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for object. |
getReadLimit()
public abstract long getReadLimit() The maximum number of data bytes the server is allowed to return in the
sum of all Object messages. A read_limit of zero indicates that there
is no limit, and a negative read_limit will cause an error.
If the stream returns fewer bytes than allowed by the read_limit and no
error occurred, the stream includes all data from the read_offset to the
end of the resource.
int64 read_limit = 5;
| Returns | |
|---|---|
| Type | Description |
long |
The readLimit. |
getReadMask()
public abstract FieldMask getReadMask()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The readMask. |
getReadMaskOrBuilder()
public abstract FieldMaskOrBuilder getReadMaskOrBuilder()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
getReadOffset()
public abstract long getReadOffset()The offset for the first byte to return in the read, relative to the start of the object.
A negative read_offset value will be interpreted as the number of bytes
back from the end of the object to be returned. For example, if an object's
length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
read_limit = 3 would return bytes 10 through 12 of the object. Requesting
a negative offset with magnitude larger than the size of the object will
return the entire object.
int64 read_offset = 4;
| Returns | |
|---|---|
| Type | Description |
long |
The readOffset. |
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 = 10;
| 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 = 6;
| 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 = 7;
| 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 = 8;
| 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 = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ifMetagenerationNotMatch field is set. |
hasReadMask()
public abstract boolean hasReadMask()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the readMask field is set. |