Package com.google.bytestream
Class ByteStreamProto.ReadRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<ByteStreamProto.ReadRequest,ByteStreamProto.ReadRequest.Builder>
com.google.bytestream.ByteStreamProto.ReadRequest
- All Implemented Interfaces:
ByteStreamProto.ReadRequestOrBuilder
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
- Enclosing class:
- ByteStreamProto
public static final class ByteStreamProto.ReadRequest
extends com.google.protobuf.GeneratedMessageLite<ByteStreamProto.ReadRequest,ByteStreamProto.ReadRequest.Builder>
implements ByteStreamProto.ReadRequestOrBuilder
Request object for ByteStream.Read.Protobuf type
google.bytestream.ReadRequest
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Request object for ByteStream.Read.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,
?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite, Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageLite
unknownFields
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionprotected final Object
dynamicMethod
(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) static ByteStreamProto.ReadRequest
long
The maximum number of `data` bytes the server is allowed to return in the sum of all `ReadResponse` messages.long
The offset for the first byte to return in the read, relative to the start of the resource.The name of the resource to read.com.google.protobuf.ByteString
The name of the resource to read.newBuilder
(ByteStreamProto.ReadRequest prototype) static ByteStreamProto.ReadRequest
parseDelimitedFrom
(InputStream input) static ByteStreamProto.ReadRequest
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ByteStreamProto.ReadRequest
parseFrom
(byte[] data) static ByteStreamProto.ReadRequest
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ByteStreamProto.ReadRequest
parseFrom
(com.google.protobuf.ByteString data) static ByteStreamProto.ReadRequest
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ByteStreamProto.ReadRequest
parseFrom
(com.google.protobuf.CodedInputStream input) static ByteStreamProto.ReadRequest
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ByteStreamProto.ReadRequest
parseFrom
(InputStream input) static ByteStreamProto.ReadRequest
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ByteStreamProto.ReadRequest
parseFrom
(ByteBuffer data) static ByteStreamProto.ReadRequest
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ByteStreamProto.ReadRequest>
parser()
Methods inherited from class com.google.protobuf.GeneratedMessageLite
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
RESOURCE_NAME_FIELD_NUMBER
public static final int RESOURCE_NAME_FIELD_NUMBER- See Also:
-
READ_OFFSET_FIELD_NUMBER
public static final int READ_OFFSET_FIELD_NUMBER- See Also:
-
READ_LIMIT_FIELD_NUMBER
public static final int READ_LIMIT_FIELD_NUMBER- See Also:
-
-
Method Details
-
getResourceName
The name of the resource to read.
string resource_name = 1 [json_name = "resourceName"];
- Specified by:
getResourceName
in interfaceByteStreamProto.ReadRequestOrBuilder
- Returns:
- The resourceName.
-
getResourceNameBytes
public com.google.protobuf.ByteString getResourceNameBytes()The name of the resource to read.
string resource_name = 1 [json_name = "resourceName"];
- Specified by:
getResourceNameBytes
in interfaceByteStreamProto.ReadRequestOrBuilder
- Returns:
- The bytes for resourceName.
-
getReadOffset
public long getReadOffset()The offset for the first byte to return in the read, relative to the start of the resource. A `read_offset` that is negative or greater than the size of the resource will cause an `OUT_OF_RANGE` error.
int64 read_offset = 2 [json_name = "readOffset"];
- Specified by:
getReadOffset
in interfaceByteStreamProto.ReadRequestOrBuilder
- Returns:
- The readOffset.
-
getReadLimit
public long getReadLimit()The maximum number of `data` bytes the server is allowed to return in the sum of all `ReadResponse` messages. A `read_limit` of zero indicates that there is no limit, and a negative `read_limit` will cause an error. If the stream returns fewer bytes than allowed by the `read_limit` and no error occurred, the stream includes all data from the `read_offset` to the end of the resource.
int64 read_limit = 3 [json_name = "readLimit"];
- Specified by:
getReadLimit
in interfaceByteStreamProto.ReadRequestOrBuilder
- Returns:
- The readLimit.
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ByteStreamProto.ReadRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ByteStreamProto.ReadRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) - Specified by:
dynamicMethod
in classcom.google.protobuf.GeneratedMessageLite<ByteStreamProto.ReadRequest,
ByteStreamProto.ReadRequest.Builder>
-
getDefaultInstance
-
parser
-