public final class PartitionReadRequest extends GeneratedMessageV3 implements PartitionReadRequestOrBuilder
The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]Protobuf type
google.spanner.v1.PartitionReadRequest
Modifier and Type | Class and Description |
---|---|
static class |
PartitionReadRequest.Builder
The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
COLUMNS_FIELD_NUMBER |
static int |
INDEX_FIELD_NUMBER |
static int |
KEY_SET_FIELD_NUMBER |
static int |
PARTITION_OPTIONS_FIELD_NUMBER |
static int |
SESSION_FIELD_NUMBER |
static int |
TABLE_FIELD_NUMBER |
static int |
TRANSACTION_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getColumns(int index)
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
this request.
|
ByteString |
getColumnsBytes(int index)
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
this request.
|
int |
getColumnsCount()
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
this request.
|
ProtocolStringList |
getColumnsList()
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
this request.
|
static PartitionReadRequest |
getDefaultInstance() |
PartitionReadRequest |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
String |
getIndex()
If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
|
ByteString |
getIndexBytes()
If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
|
KeySet |
getKeySet()
Required.
|
KeySetOrBuilder |
getKeySetOrBuilder()
Required.
|
Parser<PartitionReadRequest> |
getParserForType() |
PartitionOptions |
getPartitionOptions()
Additional options that affect how many partitions are created.
|
PartitionOptionsOrBuilder |
getPartitionOptionsOrBuilder()
Additional options that affect how many partitions are created.
|
int |
getSerializedSize() |
String |
getSession()
Required.
|
ByteString |
getSessionBytes()
Required.
|
String |
getTable()
Required.
|
ByteString |
getTableBytes()
Required.
|
TransactionSelector |
getTransaction()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
|
TransactionSelectorOrBuilder |
getTransactionOrBuilder()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
|
UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasKeySet()
Required.
|
boolean |
hasPartitionOptions()
Additional options that affect how many partitions are created.
|
boolean |
hasTransaction()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static PartitionReadRequest.Builder |
newBuilder() |
static PartitionReadRequest.Builder |
newBuilder(PartitionReadRequest prototype) |
PartitionReadRequest.Builder |
newBuilderForType() |
protected PartitionReadRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static PartitionReadRequest |
parseDelimitedFrom(InputStream input) |
static PartitionReadRequest |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static PartitionReadRequest |
parseFrom(byte[] data) |
static PartitionReadRequest |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static PartitionReadRequest |
parseFrom(ByteBuffer data) |
static PartitionReadRequest |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static PartitionReadRequest |
parseFrom(ByteString data) |
static PartitionReadRequest |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static PartitionReadRequest |
parseFrom(CodedInputStream input) |
static PartitionReadRequest |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static PartitionReadRequest |
parseFrom(InputStream input) |
static PartitionReadRequest |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<PartitionReadRequest> |
parser() |
PartitionReadRequest.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int SESSION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
public static final int TABLE_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER
public static final int COLUMNS_FIELD_NUMBER
public static final int KEY_SET_FIELD_NUMBER
public static final int PARTITION_OPTIONS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public String getSession()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getSession
in interface PartitionReadRequestOrBuilder
public ByteString getSessionBytes()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getSessionBytes
in interface PartitionReadRequestOrBuilder
public boolean hasTransaction()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
hasTransaction
in interface PartitionReadRequestOrBuilder
public TransactionSelector getTransaction()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
getTransaction
in interface PartitionReadRequestOrBuilder
public TransactionSelectorOrBuilder getTransactionOrBuilder()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
getTransactionOrBuilder
in interface PartitionReadRequestOrBuilder
public String getTable()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
getTable
in interface PartitionReadRequestOrBuilder
public ByteString getTableBytes()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
getTableBytes
in interface PartitionReadRequestOrBuilder
public String getIndex()
If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
string index = 4;
getIndex
in interface PartitionReadRequestOrBuilder
public ByteString getIndexBytes()
If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
string index = 4;
getIndexBytes
in interface PartitionReadRequestOrBuilder
public ProtocolStringList getColumnsList()
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;
getColumnsList
in interface PartitionReadRequestOrBuilder
public int getColumnsCount()
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;
getColumnsCount
in interface PartitionReadRequestOrBuilder
public String getColumns(int index)
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;
getColumns
in interface PartitionReadRequestOrBuilder
index
- The index of the element to return.public ByteString getColumnsBytes(int index)
The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;
getColumnsBytes
in interface PartitionReadRequestOrBuilder
index
- The index of the value to return.public boolean hasKeySet()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index] is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names index keys in [index][google.spanner.v1.PartitionReadRequest.index]. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
hasKeySet
in interface PartitionReadRequestOrBuilder
public KeySet getKeySet()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index] is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names index keys in [index][google.spanner.v1.PartitionReadRequest.index]. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
getKeySet
in interface PartitionReadRequestOrBuilder
public KeySetOrBuilder getKeySetOrBuilder()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index] is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names index keys in [index][google.spanner.v1.PartitionReadRequest.index]. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
getKeySetOrBuilder
in interface PartitionReadRequestOrBuilder
public boolean hasPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
hasPartitionOptions
in interface PartitionReadRequestOrBuilder
public PartitionOptions getPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
getPartitionOptions
in interface PartitionReadRequestOrBuilder
public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
getPartitionOptionsOrBuilder
in interface PartitionReadRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static PartitionReadRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static PartitionReadRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static PartitionReadRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static PartitionReadRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static PartitionReadRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static PartitionReadRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static PartitionReadRequest parseFrom(InputStream input) throws IOException
IOException
public static PartitionReadRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static PartitionReadRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static PartitionReadRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static PartitionReadRequest parseFrom(CodedInputStream input) throws IOException
IOException
public static PartitionReadRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public PartitionReadRequest.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static PartitionReadRequest.Builder newBuilder()
public static PartitionReadRequest.Builder newBuilder(PartitionReadRequest prototype)
public PartitionReadRequest.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected PartitionReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static PartitionReadRequest getDefaultInstance()
public static Parser<PartitionReadRequest> parser()
public Parser<PartitionReadRequest> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public PartitionReadRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.