Class PlanSummary (2.25.1)

public final class PlanSummary extends GeneratedMessageV3 implements PlanSummaryOrBuilder

Planning phase information for the query.

Protobuf type google.datastore.v1.PlanSummary

Static Fields

INDEXES_USED_FIELD_NUMBER

public static final int INDEXES_USED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PlanSummary getDefaultInstance()
Returns
Type Description
PlanSummary

getDescriptor()

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

newBuilder()

public static PlanSummary.Builder newBuilder()
Returns
Type Description
PlanSummary.Builder

newBuilder(PlanSummary prototype)

public static PlanSummary.Builder newBuilder(PlanSummary prototype)
Parameter
Name Description
prototype PlanSummary
Returns
Type Description
PlanSummary.Builder

parseDelimitedFrom(InputStream input)

public static PlanSummary parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PlanSummary
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlanSummary parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanSummary
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PlanSummary parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PlanSummary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PlanSummary parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanSummary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PlanSummary parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PlanSummary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PlanSummary parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanSummary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PlanSummary parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PlanSummary
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PlanSummary parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanSummary
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PlanSummary parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PlanSummary
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlanSummary parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanSummary
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PlanSummary parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PlanSummary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PlanSummary parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanSummary
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PlanSummary> parser()
Returns
Type Description
Parser<PlanSummary>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PlanSummary getDefaultInstanceForType()
Returns
Type Description
PlanSummary

getIndexesUsed(int index)

public Struct getIndexesUsed(int index)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name Description
index int
Returns
Type Description
Struct

getIndexesUsedCount()

public int getIndexesUsedCount()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type Description
int

getIndexesUsedList()

public List<Struct> getIndexesUsedList()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type Description
List<Struct>

getIndexesUsedOrBuilder(int index)

public StructOrBuilder getIndexesUsedOrBuilder(int index)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name Description
index int
Returns
Type Description
StructOrBuilder

getIndexesUsedOrBuilderList()

public List<? extends StructOrBuilder> getIndexesUsedOrBuilderList()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type Description
List<? extends com.google.protobuf.StructOrBuilder>

getParserForType()

public Parser<PlanSummary> getParserForType()
Returns
Type Description
Parser<PlanSummary>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PlanSummary.Builder newBuilderForType()
Returns
Type Description
PlanSummary.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PlanSummary.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PlanSummary.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PlanSummary.Builder toBuilder()
Returns
Type Description
PlanSummary.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException