Class BidiReadObjectRequest.Builder (2.48.1)

public static final class BidiReadObjectRequest.Builder extends GeneratedMessageV3.Builder<BidiReadObjectRequest.Builder> implements BidiReadObjectRequestOrBuilder

Request message for BidiReadObject.

Protobuf type google.storage.v2.BidiReadObjectRequest

Static Methods

getDescriptor()

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

Methods

addAllReadRanges(Iterable<? extends ReadRange> values)

public BidiReadObjectRequest.Builder addAllReadRanges(Iterable<? extends ReadRange> values)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
values Iterable<? extends com.google.storage.v2.ReadRange>
Returns
Type Description
BidiReadObjectRequest.Builder

addReadRanges(ReadRange value)

public BidiReadObjectRequest.Builder addReadRanges(ReadRange value)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
value ReadRange
Returns
Type Description
BidiReadObjectRequest.Builder

addReadRanges(ReadRange.Builder builderForValue)

public BidiReadObjectRequest.Builder addReadRanges(ReadRange.Builder builderForValue)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
builderForValue ReadRange.Builder
Returns
Type Description
BidiReadObjectRequest.Builder

addReadRanges(int index, ReadRange value)

public BidiReadObjectRequest.Builder addReadRanges(int index, ReadRange value)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameters
Name Description
index int
value ReadRange
Returns
Type Description
BidiReadObjectRequest.Builder

addReadRanges(int index, ReadRange.Builder builderForValue)

public BidiReadObjectRequest.Builder addReadRanges(int index, ReadRange.Builder builderForValue)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameters
Name Description
index int
builderForValue ReadRange.Builder
Returns
Type Description
BidiReadObjectRequest.Builder

addReadRangesBuilder()

public ReadRange.Builder addReadRangesBuilder()

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Returns
Type Description
ReadRange.Builder

addReadRangesBuilder(int index)

public ReadRange.Builder addReadRangesBuilder(int index)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
index int
Returns
Type Description
ReadRange.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BidiReadObjectRequest build()
Returns
Type Description
BidiReadObjectRequest

buildPartial()

public BidiReadObjectRequest buildPartial()
Returns
Type Description
BidiReadObjectRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReadObjectSpec()

public BidiReadObjectRequest.Builder clearReadObjectSpec()

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Returns
Type Description
BidiReadObjectRequest.Builder

clearReadRanges()

public BidiReadObjectRequest.Builder clearReadRanges()

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Returns
Type Description
BidiReadObjectRequest.Builder

clone()

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

getDefaultInstanceForType()

public BidiReadObjectRequest getDefaultInstanceForType()
Returns
Type Description
BidiReadObjectRequest

getDescriptorForType()

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

getReadObjectSpec()

public BidiReadObjectSpec getReadObjectSpec()

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Returns
Type Description
BidiReadObjectSpec

The readObjectSpec.

getReadObjectSpecBuilder()

public BidiReadObjectSpec.Builder getReadObjectSpecBuilder()

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Returns
Type Description
BidiReadObjectSpec.Builder

getReadObjectSpecOrBuilder()

public BidiReadObjectSpecOrBuilder getReadObjectSpecOrBuilder()

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Returns
Type Description
BidiReadObjectSpecOrBuilder

getReadRanges(int index)

public ReadRange getReadRanges(int index)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
index int
Returns
Type Description
ReadRange

getReadRangesBuilder(int index)

public ReadRange.Builder getReadRangesBuilder(int index)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
index int
Returns
Type Description
ReadRange.Builder

getReadRangesBuilderList()

public List<ReadRange.Builder> getReadRangesBuilderList()

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Returns
Type Description
List<Builder>

getReadRangesCount()

public int getReadRangesCount()

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Returns
Type Description
int

getReadRangesList()

public List<ReadRange> getReadRangesList()

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Returns
Type Description
List<ReadRange>

getReadRangesOrBuilder(int index)

public ReadRangeOrBuilder getReadRangesOrBuilder(int index)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
index int
Returns
Type Description
ReadRangeOrBuilder

getReadRangesOrBuilderList()

public List<? extends ReadRangeOrBuilder> getReadRangesOrBuilderList()

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

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

hasReadObjectSpec()

public boolean hasReadObjectSpec()

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Returns
Type Description
boolean

Whether the readObjectSpec 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 BidiReadObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BidiReadObjectRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(BidiReadObjectRequest other)

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

mergeReadObjectSpec(BidiReadObjectSpec value)

public BidiReadObjectRequest.Builder mergeReadObjectSpec(BidiReadObjectSpec value)

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Parameter
Name Description
value BidiReadObjectSpec
Returns
Type Description
BidiReadObjectRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeReadRanges(int index)

public BidiReadObjectRequest.Builder removeReadRanges(int index)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameter
Name Description
index int
Returns
Type Description
BidiReadObjectRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setReadObjectSpec(BidiReadObjectSpec value)

public BidiReadObjectRequest.Builder setReadObjectSpec(BidiReadObjectSpec value)

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Parameter
Name Description
value BidiReadObjectSpec
Returns
Type Description
BidiReadObjectRequest.Builder

setReadObjectSpec(BidiReadObjectSpec.Builder builderForValue)

public BidiReadObjectRequest.Builder setReadObjectSpec(BidiReadObjectSpec.Builder builderForValue)

The first message of each stream should set this field. If this is not the first message, an error will be returned. Describes the object to read.

.google.storage.v2.BidiReadObjectSpec read_object_spec = 1;

Parameter
Name Description
builderForValue BidiReadObjectSpec.Builder
Returns
Type Description
BidiReadObjectRequest.Builder

setReadRanges(int index, ReadRange value)

public BidiReadObjectRequest.Builder setReadRanges(int index, ReadRange value)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameters
Name Description
index int
value ReadRange
Returns
Type Description
BidiReadObjectRequest.Builder

setReadRanges(int index, ReadRange.Builder builderForValue)

public BidiReadObjectRequest.Builder setReadRanges(int index, ReadRange.Builder builderForValue)

Provides a list of 0 or more (up to 100) ranges to read. If a single range is large enough to require multiple responses, they are guaranteed to be delivered in increasing offset order. There are no ordering guarantees across ranges. When no ranges are provided, the response message will not include ObjectRangeData. For full object downloads, the offset and size can be set to 0.

repeated .google.storage.v2.ReadRange read_ranges = 8;

Parameters
Name Description
index int
builderForValue ReadRange.Builder
Returns
Type Description
BidiReadObjectRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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