public static final class ExplainOptions.Builder extends GeneratedMessageV3.Builder<ExplainOptions.Builder> implements ExplainOptionsOrBuilder
Explain options for the query.
Protobuf type google.firestore.v1.ExplainOptions
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExplainOptions.BuilderImplements
ExplainOptionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExplainOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
build()
public ExplainOptions build()
Returns | |
---|---|
Type | Description |
ExplainOptions |
buildPartial()
public ExplainOptions buildPartial()
Returns | |
---|---|
Type | Description |
ExplainOptions |
clear()
public ExplainOptions.Builder clear()
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
clearAnalyze()
public ExplainOptions.Builder clearAnalyze()
Optional. Whether to execute this query.
When false (the default), the query will be planned, returning only metrics from the planning stages.
When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
bool analyze = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ExplainOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExplainOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
clone()
public ExplainOptions.Builder clone()
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
getAnalyze()
public boolean getAnalyze()
Optional. Whether to execute this query.
When false (the default), the query will be planned, returning only metrics from the planning stages.
When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
bool analyze = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The analyze. |
getDefaultInstanceForType()
public ExplainOptions getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ExplainOptions |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ExplainOptions other)
public ExplainOptions.Builder mergeFrom(ExplainOptions other)
Parameter | |
---|---|
Name | Description |
other |
ExplainOptions |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExplainOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ExplainOptions.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExplainOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
setAnalyze(boolean value)
public ExplainOptions.Builder setAnalyze(boolean value)
Optional. Whether to execute this query.
When false (the default), the query will be planned, returning only metrics from the planning stages.
When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
bool analyze = 1 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
boolean The analyze to set. |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ExplainOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExplainOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExplainOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExplainOptions.Builder |