public static final class ReadRange.Builder extends GeneratedMessageV3.Builder<ReadRange.Builder> implements ReadRangeOrBuilder
Describes a range of bytes to read in a BidiReadObjectRanges request.
Protobuf type google.storage.v2.ReadRange
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReadRange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
buildPartial()
public ReadRange buildPartial()
clear()
public ReadRange.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public ReadRange.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ReadRange.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearReadId()
public ReadRange.Builder clearReadId()
Required. Read identifier provided by the client. When the client issues
more than one outstanding ReadRange on the same stream, responses can be
mapped back to their corresponding requests using this value. Clients must
ensure that all outstanding requests have different read_id values. The
server may close the stream with an error if this condition is not met.
int64 read_id = 3 [(.google.api.field_behavior) = REQUIRED];
clearReadLength()
public ReadRange.Builder clearReadLength()
Optional. The maximum number of data bytes the server is allowed to return
across all response messages with the same read_id. A read_length of zero
indicates to read until the resource end, and a negative read_length will
cause an error. If the stream returns fewer bytes than allowed by the
read_length and no error occurred, the stream includes all data from the
read_offset to the resource end.
int64 read_length = 2 [(.google.api.field_behavior) = OPTIONAL];
clearReadOffset()
public ReadRange.Builder clearReadOffset()
Required. The offset for the first byte to return in the read, relative to
the start of the object.
A negative read_offset value will be interpreted as the number of bytes
back from the end of the object to be returned. For example, if an object's
length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
read_length = 3 would return bytes 10 through 12 of the object. Requesting
a negative offset with magnitude larger than the size of the object will
return the entire object. A read_offset larger than the size of the object
will result in an OutOfRange error.
int64 read_offset = 1 [(.google.api.field_behavior) = REQUIRED];
clone()
public ReadRange.Builder clone()
Overrides
getDefaultInstanceForType()
public ReadRange getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getReadId()
Required. Read identifier provided by the client. When the client issues
more than one outstanding ReadRange on the same stream, responses can be
mapped back to their corresponding requests using this value. Clients must
ensure that all outstanding requests have different read_id values. The
server may close the stream with an error if this condition is not met.
int64 read_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
long |
The readId.
|
getReadLength()
public long getReadLength()
Optional. The maximum number of data bytes the server is allowed to return
across all response messages with the same read_id. A read_length of zero
indicates to read until the resource end, and a negative read_length will
cause an error. If the stream returns fewer bytes than allowed by the
read_length and no error occurred, the stream includes all data from the
read_offset to the resource end.
int64 read_length = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
long |
The readLength.
|
getReadOffset()
public long getReadOffset()
Required. The offset for the first byte to return in the read, relative to
the start of the object.
A negative read_offset value will be interpreted as the number of bytes
back from the end of the object to be returned. For example, if an object's
length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
read_length = 3 would return bytes 10 through 12 of the object. Requesting
a negative offset with magnitude larger than the size of the object will
return the entire object. A read_offset larger than the size of the object
will result in an OutOfRange error.
int64 read_offset = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
long |
The readOffset.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
public ReadRange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public ReadRange.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeFrom(ReadRange other)
public ReadRange.Builder mergeFrom(ReadRange other)
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReadRange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public ReadRange.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setReadId(long value)
public ReadRange.Builder setReadId(long value)
Required. Read identifier provided by the client. When the client issues
more than one outstanding ReadRange on the same stream, responses can be
mapped back to their corresponding requests using this value. Clients must
ensure that all outstanding requests have different read_id values. The
server may close the stream with an error if this condition is not met.
int64 read_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
long
The readId to set.
|
setReadLength(long value)
public ReadRange.Builder setReadLength(long value)
Optional. The maximum number of data bytes the server is allowed to return
across all response messages with the same read_id. A read_length of zero
indicates to read until the resource end, and a negative read_length will
cause an error. If the stream returns fewer bytes than allowed by the
read_length and no error occurred, the stream includes all data from the
read_offset to the resource end.
int64 read_length = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
value |
long
The readLength to set.
|
setReadOffset(long value)
public ReadRange.Builder setReadOffset(long value)
Required. The offset for the first byte to return in the read, relative to
the start of the object.
A negative read_offset value will be interpreted as the number of bytes
back from the end of the object to be returned. For example, if an object's
length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
read_length = 3 would return bytes 10 through 12 of the object. Requesting
a negative offset with magnitude larger than the size of the object will
return the entire object. A read_offset larger than the size of the object
will result in an OutOfRange error.
int64 read_offset = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
long
The readOffset to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReadRange.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ReadRange.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
