Class PlanSummary.Builder (2.20.0)

public static final class PlanSummary.Builder extends GeneratedMessageV3.Builder<PlanSummary.Builder> implements PlanSummaryOrBuilder

Planning phase information for the query.

Protobuf type google.datastore.v1.PlanSummary

Static Methods

getDescriptor()

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

Methods

addAllIndexesUsed(Iterable<? extends Struct> values)

public PlanSummary.Builder addAllIndexesUsed(Iterable<? extends Struct> values)

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
values Iterable<? extends com.google.protobuf.Struct>
Returns
Type Description
PlanSummary.Builder

addIndexesUsed(Struct value)

public PlanSummary.Builder addIndexesUsed(Struct value)

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
value Struct
Returns
Type Description
PlanSummary.Builder

addIndexesUsed(Struct.Builder builderForValue)

public PlanSummary.Builder addIndexesUsed(Struct.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
PlanSummary.Builder

addIndexesUsed(int index, Struct value)

public PlanSummary.Builder addIndexesUsed(int index, Struct value)

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;

Parameters
Name Description
index int
value Struct
Returns
Type Description
PlanSummary.Builder

addIndexesUsed(int index, Struct.Builder builderForValue)

public PlanSummary.Builder addIndexesUsed(int index, Struct.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
PlanSummary.Builder

addIndexesUsedBuilder()

public Struct.Builder addIndexesUsedBuilder()

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
Builder

addIndexesUsedBuilder(int index)

public Struct.Builder addIndexesUsedBuilder(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
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PlanSummary.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PlanSummary.Builder
Overrides

build()

public PlanSummary build()
Returns
Type Description
PlanSummary

buildPartial()

public PlanSummary buildPartial()
Returns
Type Description
PlanSummary

clear()

public PlanSummary.Builder clear()
Returns
Type Description
PlanSummary.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PlanSummary.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PlanSummary.Builder
Overrides

clearIndexesUsed()

public PlanSummary.Builder clearIndexesUsed()

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
PlanSummary.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PlanSummary.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PlanSummary.Builder
Overrides

clone()

public PlanSummary.Builder clone()
Returns
Type Description
PlanSummary.Builder
Overrides

getDefaultInstanceForType()

public PlanSummary getDefaultInstanceForType()
Returns
Type Description
PlanSummary

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getIndexesUsedBuilder(int index)

public Struct.Builder getIndexesUsedBuilder(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
Builder

getIndexesUsedBuilderList()

public List<Struct.Builder> getIndexesUsedBuilderList()

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<Builder>

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>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PlanSummary other)

public PlanSummary.Builder mergeFrom(PlanSummary other)
Parameter
Name Description
other PlanSummary
Returns
Type Description
PlanSummary.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PlanSummary.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanSummary.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PlanSummary.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PlanSummary.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PlanSummary.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PlanSummary.Builder
Overrides

removeIndexesUsed(int index)

public PlanSummary.Builder removeIndexesUsed(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
PlanSummary.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PlanSummary.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PlanSummary.Builder
Overrides

setIndexesUsed(int index, Struct value)

public PlanSummary.Builder setIndexesUsed(int index, Struct value)

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;

Parameters
Name Description
index int
value Struct
Returns
Type Description
PlanSummary.Builder

setIndexesUsed(int index, Struct.Builder builderForValue)

public PlanSummary.Builder setIndexesUsed(int index, Struct.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
PlanSummary.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PlanSummary.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PlanSummary.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PlanSummary.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PlanSummary.Builder
Overrides