Class ReadObjectRequest (2.3.0) 

public final class ReadObjectRequest extends GeneratedMessageV3 implements ReadObjectRequestOrBuilder

Request message for ReadObject.

Protobuf type google.storage.v2.ReadObjectRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReadObjectRequest

Static Fields

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER
Field Value
Type Description
int

COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

COMMON_REQUEST_PARAMS_FIELD_NUMBER

public static final int COMMON_REQUEST_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

GENERATION_FIELD_NUMBER

public static final int GENERATION_FIELD_NUMBER
Field Value
Type Description
int

IF_GENERATION_MATCH_FIELD_NUMBER

public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_GENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

OBJECT_FIELD_NUMBER

public static final int OBJECT_FIELD_NUMBER
Field Value
Type Description
int

READ_LIMIT_FIELD_NUMBER

public static final int READ_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
Type Description
int

READ_OFFSET_FIELD_NUMBER

public static final int READ_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReadObjectRequest getDefaultInstance()
Returns
Type Description
ReadObjectRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ReadObjectRequest.Builder newBuilder()
Returns
Type Description
ReadObjectRequest.Builder

newBuilder(ReadObjectRequest prototype)

public static ReadObjectRequest.Builder newBuilder(ReadObjectRequest prototype)
Parameter
Name Description
prototype ReadObjectRequest
Returns
Type Description
ReadObjectRequest.Builder

parseDelimitedFrom(InputStream input)

public static ReadObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReadObjectRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadObjectRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadObjectRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReadObjectRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReadObjectRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReadObjectRequest> parser()
Returns
Type Description
Parser<ReadObjectRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBucket()

public String getBucket()

The name of the bucket containing the object to read.

string bucket = 1;

Returns
Type Description
String

The bucket.

getBucketBytes()

public ByteString getBucketBytes()

The name of the bucket containing the object to read.

string bucket = 1;

Returns
Type Description
ByteString

The bytes for bucket.

getCommonObjectRequestParams()

public 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 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

getCommonRequestParams()

public CommonRequestParams getCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 11;

Returns
Type Description
CommonRequestParams

The commonRequestParams.

getCommonRequestParamsOrBuilder()

public CommonRequestParamsOrBuilder getCommonRequestParamsOrBuilder()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 11;

Returns
Type Description
CommonRequestParamsOrBuilder

getDefaultInstanceForType()

public ReadObjectRequest getDefaultInstanceForType()
Returns
Type Description
ReadObjectRequest

getGeneration()

public 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 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 long getIfGenerationNotMatch()

Makes the operation conditional on whether the object's current 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 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 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 String getObject()

The name of the object to read.

string object = 2;

Returns
Type Description
String

The object.

getObjectBytes()

public ByteString getObjectBytes()

The name of the object to read.

string object = 2;

Returns
Type Description
ByteString

The bytes for object.

getParserForType()

public Parser<ReadObjectRequest> getParserForType()
Returns
Type Description
Parser<ReadObjectRequest>
Overrides

getReadLimit()

public 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 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 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 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 whose magnitude is larger than the size of the object will result in an error.

int64 read_offset = 4;

Returns
Type Description
long

The readOffset.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasCommonObjectRequestParams()

public 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.

hasCommonRequestParams()

public boolean hasCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 11;

Returns
Type Description
boolean

Whether the commonRequestParams field is set.

hasIfGenerationMatch()

public 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 boolean hasIfGenerationNotMatch()

Makes the operation conditional on whether the object's current 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReadObjectRequest.Builder newBuilderForType()
Returns
Type Description
ReadObjectRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReadObjectRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReadObjectRequest.Builder toBuilder()
Returns
Type Description
ReadObjectRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException