Class QueryAdvisorResult.IndexAdvice.Builder (6.108.0)

public static final class QueryAdvisorResult.IndexAdvice.Builder extends GeneratedMessage.Builder<QueryAdvisorResult.IndexAdvice.Builder> implements QueryAdvisorResult.IndexAdviceOrBuilder

Recommendation to add new indexes to run queries more efficiently.

Protobuf type google.spanner.v1.QueryAdvisorResult.IndexAdvice

Static Methods

getDescriptor()

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

Methods

addAllDdl(Iterable<String> values)

public QueryAdvisorResult.IndexAdvice.Builder addAllDdl(Iterable<String> values)

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The ddl to add.

Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

This builder for chaining.

addDdl(String value)

public QueryAdvisorResult.IndexAdvice.Builder addDdl(String value)

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The ddl to add.

Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

This builder for chaining.

addDdlBytes(ByteString value)

public QueryAdvisorResult.IndexAdvice.Builder addDdlBytes(ByteString value)

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the ddl to add.

Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

This builder for chaining.

build()

public QueryAdvisorResult.IndexAdvice build()
Returns
Type Description
QueryAdvisorResult.IndexAdvice

buildPartial()

public QueryAdvisorResult.IndexAdvice buildPartial()
Returns
Type Description
QueryAdvisorResult.IndexAdvice

clear()

public QueryAdvisorResult.IndexAdvice.Builder clear()
Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder
Overrides

clearDdl()

public QueryAdvisorResult.IndexAdvice.Builder clearDdl()

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

This builder for chaining.

clearImprovementFactor()

public QueryAdvisorResult.IndexAdvice.Builder clearImprovementFactor()

Optional. Estimated latency improvement factor. For example if the query currently takes 500 ms to run and the estimated latency with new indexes is 100 ms this field will be 5.

double improvement_factor = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

This builder for chaining.

getDdl(int index)

public String getDdl(int index)

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The ddl at the given index.

getDdlBytes(int index)

public ByteString getDdlBytes(int index)

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the ddl at the given index.

getDdlCount()

public int getDdlCount()

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of ddl.

getDdlList()

public ProtocolStringList getDdlList()

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the ddl.

getDefaultInstanceForType()

public QueryAdvisorResult.IndexAdvice getDefaultInstanceForType()
Returns
Type Description
QueryAdvisorResult.IndexAdvice

getDescriptorForType()

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

getImprovementFactor()

public double getImprovementFactor()

Optional. Estimated latency improvement factor. For example if the query currently takes 500 ms to run and the estimated latency with new indexes is 100 ms this field will be 5.

double improvement_factor = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The improvementFactor.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(QueryAdvisorResult.IndexAdvice other)

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

setDdl(int index, String value)

public QueryAdvisorResult.IndexAdvice.Builder setDdl(int index, String value)

Optional. DDL statements to add new indexes that will improve the query.

repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The ddl to set.

Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

This builder for chaining.

setImprovementFactor(double value)

public QueryAdvisorResult.IndexAdvice.Builder setImprovementFactor(double value)

Optional. Estimated latency improvement factor. For example if the query currently takes 500 ms to run and the estimated latency with new indexes is 100 ms this field will be 5.

double improvement_factor = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The improvementFactor to set.

Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

This builder for chaining.