Interface ReadObjectRequestOrBuilder (2.64.0)

2.64.0 (latest) 2.63.0 2.62.1 2.60.0 2.59.0 2.58.1 2.57.0 2.56.0 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 ReadObjectRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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()

Optional. A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CommonObjectRequestParams	The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder()

public abstract CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

Optional. A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CommonObjectRequestParamsOrBuilder

getGeneration()

public abstract long getGeneration()

Optional. If present, selects a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 3 [(.google.api.field_behavior) = OPTIONAL];

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()

Optional. 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 causes 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
long	The readLimit.

getReadMask()

public abstract FieldMask getReadMask()

Mask specifying which fields to read. The checksummed_data field and its children are always present. If no mask is specified, it defaults to all fields except metadata. owner and metadata.acl. * might 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 are always present. If no mask is specified, it defaults to all fields except metadata. owner and metadata.acl. * might be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 12;

Returns
Type	Description
FieldMaskOrBuilder

getReadOffset()

public abstract long getReadOffset()

Optional. The offset for the first byte to return in the read, relative to the start of the object.

A negative read_offset value is 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 returns the entire object.

int64 read_offset = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
long	The readOffset.

hasCommonObjectRequestParams()

public abstract boolean hasCommonObjectRequestParams()

Optional. A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10 [(.google.api.field_behavior) = OPTIONAL];

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 are always present. If no mask is specified, it defaults to all fields except metadata. owner and metadata.acl. * might be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 12;

Returns
Type	Description
boolean	Whether the readMask field is set.