Class BidiReadObjectResponse.Builder (2.48.1)

public static final class BidiReadObjectResponse.Builder extends GeneratedMessageV3.Builder<BidiReadObjectResponse.Builder> implements BidiReadObjectResponseOrBuilder

Response message for BidiReadObject.

Protobuf type google.storage.v2.BidiReadObjectResponse

Static Methods

getDescriptor()

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

Methods

addAllObjectDataRanges(Iterable<? extends ObjectRangeData> values)

public BidiReadObjectResponse.Builder addAllObjectDataRanges(Iterable<? extends ObjectRangeData> values)

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
values Iterable<? extends com.google.storage.v2.ObjectRangeData>
Returns
Type Description
BidiReadObjectResponse.Builder

addObjectDataRanges(ObjectRangeData value)

public BidiReadObjectResponse.Builder addObjectDataRanges(ObjectRangeData value)

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
value ObjectRangeData
Returns
Type Description
BidiReadObjectResponse.Builder

addObjectDataRanges(ObjectRangeData.Builder builderForValue)

public BidiReadObjectResponse.Builder addObjectDataRanges(ObjectRangeData.Builder builderForValue)

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
builderForValue ObjectRangeData.Builder
Returns
Type Description
BidiReadObjectResponse.Builder

addObjectDataRanges(int index, ObjectRangeData value)

public BidiReadObjectResponse.Builder addObjectDataRanges(int index, ObjectRangeData value)

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;

Parameters
Name Description
index int
value ObjectRangeData
Returns
Type Description
BidiReadObjectResponse.Builder

addObjectDataRanges(int index, ObjectRangeData.Builder builderForValue)

public BidiReadObjectResponse.Builder addObjectDataRanges(int index, ObjectRangeData.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ObjectRangeData.Builder
Returns
Type Description
BidiReadObjectResponse.Builder

addObjectDataRangesBuilder()

public ObjectRangeData.Builder addObjectDataRangesBuilder()

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
ObjectRangeData.Builder

addObjectDataRangesBuilder(int index)

public ObjectRangeData.Builder addObjectDataRangesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BidiReadObjectResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

build()

public BidiReadObjectResponse build()
Returns
Type Description
BidiReadObjectResponse

buildPartial()

public BidiReadObjectResponse buildPartial()
Returns
Type Description
BidiReadObjectResponse

clear()

public BidiReadObjectResponse.Builder clear()
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public BidiReadObjectResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

clearMetadata()

public BidiReadObjectResponse.Builder clearMetadata()

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
BidiReadObjectResponse.Builder

clearObjectDataRanges()

public BidiReadObjectResponse.Builder clearObjectDataRanges()

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
BidiReadObjectResponse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BidiReadObjectResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

clearReadHandle()

public BidiReadObjectResponse.Builder clearReadHandle()

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
BidiReadObjectResponse.Builder

clone()

public BidiReadObjectResponse.Builder clone()
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

getDefaultInstanceForType()

public BidiReadObjectResponse getDefaultInstanceForType()
Returns
Type Description
BidiReadObjectResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMetadataBuilder()

public Object.Builder getMetadataBuilder()

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

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

getObjectDataRangesBuilder(int index)

public ObjectRangeData.Builder getObjectDataRangesBuilder(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.Builder

getObjectDataRangesBuilderList()

public List<ObjectRangeData.Builder> getObjectDataRangesBuilderList()

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

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>

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.

getReadHandleBuilder()

public BidiReadHandle.Builder getReadHandleBuilder()

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

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BidiReadObjectResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BidiReadObjectResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

mergeFrom(BidiReadObjectResponse other)

public BidiReadObjectResponse.Builder mergeFrom(BidiReadObjectResponse other)
Parameter
Name Description
other BidiReadObjectResponse
Returns
Type Description
BidiReadObjectResponse.Builder

mergeMetadata(Object value)

public BidiReadObjectResponse.Builder mergeMetadata(Object value)

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;

Parameter
Name Description
value Object
Returns
Type Description
BidiReadObjectResponse.Builder

mergeReadHandle(BidiReadHandle value)

public BidiReadObjectResponse.Builder mergeReadHandle(BidiReadHandle value)

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;

Parameter
Name Description
value BidiReadHandle
Returns
Type Description
BidiReadObjectResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BidiReadObjectResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

removeObjectDataRanges(int index)

public BidiReadObjectResponse.Builder removeObjectDataRanges(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
BidiReadObjectResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BidiReadObjectResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

setMetadata(Object value)

public BidiReadObjectResponse.Builder setMetadata(Object value)

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;

Parameter
Name Description
value Object
Returns
Type Description
BidiReadObjectResponse.Builder

setMetadata(Object.Builder builderForValue)

public BidiReadObjectResponse.Builder setMetadata(Object.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Object.Builder
Returns
Type Description
BidiReadObjectResponse.Builder

setObjectDataRanges(int index, ObjectRangeData value)

public BidiReadObjectResponse.Builder setObjectDataRanges(int index, ObjectRangeData value)

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;

Parameters
Name Description
index int
value ObjectRangeData
Returns
Type Description
BidiReadObjectResponse.Builder

setObjectDataRanges(int index, ObjectRangeData.Builder builderForValue)

public BidiReadObjectResponse.Builder setObjectDataRanges(int index, ObjectRangeData.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ObjectRangeData.Builder
Returns
Type Description
BidiReadObjectResponse.Builder

setReadHandle(BidiReadHandle value)

public BidiReadObjectResponse.Builder setReadHandle(BidiReadHandle value)

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;

Parameter
Name Description
value BidiReadHandle
Returns
Type Description
BidiReadObjectResponse.Builder

setReadHandle(BidiReadHandle.Builder builderForValue)

public BidiReadObjectResponse.Builder setReadHandle(BidiReadHandle.Builder builderForValue)

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;

Parameter
Name Description
builderForValue BidiReadHandle.Builder
Returns
Type Description
BidiReadObjectResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BidiReadObjectResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BidiReadObjectResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BidiReadObjectResponse.Builder
Overrides