Class ReadObjectResponse (2.38.0)

public final class ReadObjectResponse extends GeneratedMessageV3 implements ReadObjectResponseOrBuilder

Response message for ReadObject.

Protobuf type google.storage.v2.ReadObjectResponse

Static Fields

CHECKSUMMED_DATA_FIELD_NUMBER

public static final int CHECKSUMMED_DATA_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_RANGE_FIELD_NUMBER

public static final int CONTENT_RANGE_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

OBJECT_CHECKSUMS_FIELD_NUMBER

public static final int OBJECT_CHECKSUMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReadObjectResponse getDefaultInstance()
Returns
Type Description
ReadObjectResponse

getDescriptor()

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

newBuilder()

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

newBuilder(ReadObjectResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getChecksummedData()

public ChecksummedData getChecksummedData()

A portion of the data for the object. The service may leave data empty for any given ReadResponse. This enables the service to inform the client that the request is still live while it is running an operation to generate more data.

.google.storage.v2.ChecksummedData checksummed_data = 1;

Returns
Type Description
ChecksummedData

The checksummedData.

getChecksummedDataOrBuilder()

public ChecksummedDataOrBuilder getChecksummedDataOrBuilder()

A portion of the data for the object. The service may leave data empty for any given ReadResponse. This enables the service to inform the client that the request is still live while it is running an operation to generate more data.

.google.storage.v2.ChecksummedData checksummed_data = 1;

Returns
Type Description
ChecksummedDataOrBuilder

getContentRange()

public ContentRange getContentRange()

If read_offset and or read_limit was specified on the ReadObjectRequest, ContentRange will be populated on the first ReadObjectResponse message of the read stream.

.google.storage.v2.ContentRange content_range = 3;

Returns
Type Description
ContentRange

The contentRange.

getContentRangeOrBuilder()

public ContentRangeOrBuilder getContentRangeOrBuilder()

If read_offset and or read_limit was specified on the ReadObjectRequest, ContentRange will be populated on the first ReadObjectResponse message of the read stream.

.google.storage.v2.ContentRange content_range = 3;

Returns
Type Description
ContentRangeOrBuilder

getDefaultInstanceForType()

public ReadObjectResponse getDefaultInstanceForType()
Returns
Type Description
ReadObjectResponse

getMetadata()

public Object getMetadata()

Metadata of the object whose media is being returned. Only populated in the first response in the stream.

.google.storage.v2.Object metadata = 4;

Returns
Type Description
Object

The metadata.

getMetadataOrBuilder()

public ObjectOrBuilder getMetadataOrBuilder()

Metadata of the object whose media is being returned. Only populated in the first response in the stream.

.google.storage.v2.Object metadata = 4;

Returns
Type Description
ObjectOrBuilder

getObjectChecksums()

public ObjectChecksums getObjectChecksums()

The checksums of the complete object. 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 object_checksums = 2;

Returns
Type Description
ObjectChecksums

The objectChecksums.

getObjectChecksumsOrBuilder()

public ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder()

The checksums of the complete object. 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 object_checksums = 2;

Returns
Type Description
ObjectChecksumsOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasChecksummedData()

public boolean hasChecksummedData()

A portion of the data for the object. The service may leave data empty for any given ReadResponse. This enables the service to inform the client that the request is still live while it is running an operation to generate more data.

.google.storage.v2.ChecksummedData checksummed_data = 1;

Returns
Type Description
boolean

Whether the checksummedData field is set.

hasContentRange()

public boolean hasContentRange()

If read_offset and or read_limit was specified on the ReadObjectRequest, ContentRange will be populated on the first ReadObjectResponse message of the read stream.

.google.storage.v2.ContentRange content_range = 3;

Returns
Type Description
boolean

Whether the contentRange field is set.

hasMetadata()

public boolean hasMetadata()

Metadata of the object whose media is being returned. Only populated in the first response in the stream.

.google.storage.v2.Object metadata = 4;

Returns
Type Description
boolean

Whether the metadata field is set.

hasObjectChecksums()

public boolean hasObjectChecksums()

The checksums of the complete object. 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 object_checksums = 2;

Returns
Type Description
boolean

Whether the objectChecksums 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 ReadObjectResponse.Builder newBuilderForType()
Returns
Type Description
ReadObjectResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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