- 2.62.1 (latest)
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.1
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.3
- 2.52.3
- 2.50.0
- 2.49.0
- 2.48.2
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.1
- 2.43.2
- 2.42.0
- 2.41.0
- 2.40.1
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.1
- 2.34.0
- 2.33.0
- 2.32.1
- 2.30.1
- 2.29.1
- 2.28.0
- 2.27.1
- 2.24.0
- 2.23.0
- 2.22.6
- 2.21.0
- 2.20.2
- 2.19.0
- 2.18.0
- 2.17.2
- 2.16.0
- 2.15.1
- 2.14.0
- 2.13.1
- 2.12.0
- 2.11.3
- 2.10.0
- 2.9.3
- 2.8.1
- 2.7.1
- 2.6.1
- 2.5.1
- 2.4.5
- 2.3.0
- 2.2.3
- 2.1.10
public static final class ReadRange.Builder extends GeneratedMessage.Builder<ReadRange.Builder> implements ReadRangeOrBuilder Describes a range of bytes to read in a BidiReadObjectRanges request.
Protobuf type google.storage.v2.ReadRange
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ReadRange.BuilderImplements
ReadRangeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ReadRange build()| Returns | |
|---|---|
| Type | Description |
ReadRange |
|
buildPartial()
public ReadRange buildPartial()| Returns | |
|---|---|
| Type | Description |
ReadRange |
|
clear()
public ReadRange.Builder clear()| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
|
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 might close the stream with an error if this condition is not met.
int64 read_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
This builder for chaining. |
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
causes 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 |
ReadRange.Builder |
This builder for chaining. |
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 is 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 returns the entire object. A read_offset larger than the size
of the object results in an OutOfRange error.
int64 read_offset = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public ReadRange getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ReadRange |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getReadId()
public long 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 might 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
causes 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 is 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 returns the entire object. A read_offset larger than the size
of the object results in an OutOfRange error.
int64 read_offset = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
long |
The readOffset. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ReadRange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ReadRange.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
|
mergeFrom(ReadRange other)
public ReadRange.Builder mergeFrom(ReadRange other)| Parameter | |
|---|---|
| Name | Description |
other |
ReadRange |
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
|
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 might 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 |
longThe readId to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
This builder for chaining. |
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
causes 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 |
longThe readLength to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
This builder for chaining. |
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 is 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 returns the entire object. A read_offset larger than the size
of the object results in an OutOfRange error.
int64 read_offset = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe readOffset to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRange.Builder |
This builder for chaining. |