Interface BidiReadObjectResponseOrBuilder (2.48.1)

public interface BidiReadObjectResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMetadata()

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

getReadHandle()

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

hasMetadata()

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