Class BidiReadObjectResponse (2.48.1) 

public final class BidiReadObjectResponse extends GeneratedMessageV3 implements BidiReadObjectResponseOrBuilder

Response message for BidiReadObject.

Protobuf type google.storage.v2.BidiReadObjectResponse

Inheritance

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

Static Fields

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

OBJECT_DATA_RANGES_FIELD_NUMBER

public static final int OBJECT_DATA_RANGES_FIELD_NUMBER
Field Value
Type Description
int

READ_HANDLE_FIELD_NUMBER

public static final int READ_HANDLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BidiReadObjectResponse getDefaultInstance()
Returns
Type Description
BidiReadObjectResponse

getDescriptor()

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

newBuilder()

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

newBuilder(BidiReadObjectResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BidiReadObjectResponse getDefaultInstanceForType()
Returns
Type Description
BidiReadObjectResponse

getMetadata()

public Object getMetadata()

Metadata of the object whose media is being returned. Only populated in the first response in the stream and not populated when the stream is opened with a read handle.

.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 and not populated when the stream is opened with a read handle.

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

Returns
Type Description
ObjectOrBuilder

getObjectDataRanges(int index)

public ObjectRangeData getObjectDataRanges(int index)

A portion of the object's data. 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. The service may pipeline multiple responses belonging to different read requests. Each ObjectRangeData entry will have a read_id set to the same value as the corresponding source read request.

repeated .google.storage.v2.ObjectRangeData object_data_ranges = 6;

Parameter
Name Description
index int
Returns
Type Description
ObjectRangeData

getObjectDataRangesCount()

public int getObjectDataRangesCount()

A portion of the object's data. 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. The service may pipeline multiple responses belonging to different read requests. Each ObjectRangeData entry will have a read_id set to the same value as the corresponding source read request.

repeated .google.storage.v2.ObjectRangeData object_data_ranges = 6;

Returns
Type Description
int

getObjectDataRangesList()

public List<ObjectRangeData> getObjectDataRangesList()

A portion of the object's data. 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. The service may pipeline multiple responses belonging to different read requests. Each ObjectRangeData entry will have a read_id set to the same value as the corresponding source read request.

repeated .google.storage.v2.ObjectRangeData object_data_ranges = 6;

Returns
Type Description
List<ObjectRangeData>

getObjectDataRangesOrBuilder(int index)

public ObjectRangeDataOrBuilder getObjectDataRangesOrBuilder(int index)

A portion of the object's data. 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. The service may pipeline multiple responses belonging to different read requests. Each ObjectRangeData entry will have a read_id set to the same value as the corresponding source read request.

repeated .google.storage.v2.ObjectRangeData object_data_ranges = 6;

Parameter
Name Description
index int
Returns
Type Description
ObjectRangeDataOrBuilder

getObjectDataRangesOrBuilderList()

public List<? extends ObjectRangeDataOrBuilder> getObjectDataRangesOrBuilderList()

A portion of the object's data. 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. The service may pipeline multiple responses belonging to different read requests. Each ObjectRangeData entry will have a read_id set to the same value as the corresponding source read request.

repeated .google.storage.v2.ObjectRangeData object_data_ranges = 6;

Returns
Type Description
List<? extends com.google.storage.v2.ObjectRangeDataOrBuilder>

getParserForType()

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

getReadHandle()

public BidiReadHandle getReadHandle()

This field will be periodically refreshed, however it may not be set in every response. It allows the client to more efficiently open subsequent bidirectional streams to the same object.

.google.storage.v2.BidiReadHandle read_handle = 7;

Returns
Type Description
BidiReadHandle

The readHandle.

getReadHandleOrBuilder()

public BidiReadHandleOrBuilder getReadHandleOrBuilder()

This field will be periodically refreshed, however it may not be set in every response. It allows the client to more efficiently open subsequent bidirectional streams to the same object.

.google.storage.v2.BidiReadHandle read_handle = 7;

Returns
Type Description
BidiReadHandleOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMetadata()

public boolean hasMetadata()

Metadata of the object whose media is being returned. Only populated in the first response in the stream and not populated when the stream is opened with a read handle.

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

Returns
Type Description
boolean

Whether the metadata field is set.

hasReadHandle()

public boolean hasReadHandle()

This field will be periodically refreshed, however it may not be set in every response. It allows the client to more efficiently open subsequent bidirectional streams to the same object.

.google.storage.v2.BidiReadHandle read_handle = 7;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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