Class QueryAdvisorResult.IndexAdvice (6.107.0)

public static final class QueryAdvisorResult.IndexAdvice extends GeneratedMessageV3 implements QueryAdvisorResult.IndexAdviceOrBuilder

Recommendation to add new indexes to run queries more efficiently.

Protobuf type google.spanner.v1.QueryAdvisorResult.IndexAdvice

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > QueryAdvisorResult.IndexAdvice

Static Fields

DDL_FIELD_NUMBER

public static final int DDL_FIELD_NUMBER
Field Value
Type Description
int

IMPROVEMENT_FACTOR_FIELD_NUMBER

public static final int IMPROVEMENT_FACTOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryAdvisorResult.IndexAdvice getDefaultInstance()
Returns
Type Description
QueryAdvisorResult.IndexAdvice

getDescriptor()

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

newBuilder()

public static QueryAdvisorResult.IndexAdvice.Builder newBuilder()
Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

newBuilder(QueryAdvisorResult.IndexAdvice prototype)

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

parseDelimitedFrom(InputStream input)

public static QueryAdvisorResult.IndexAdvice parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryAdvisorResult.IndexAdvice
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static QueryAdvisorResult.IndexAdvice parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryAdvisorResult.IndexAdvice
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static QueryAdvisorResult.IndexAdvice parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryAdvisorResult.IndexAdvice
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static QueryAdvisorResult.IndexAdvice parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryAdvisorResult.IndexAdvice
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static QueryAdvisorResult.IndexAdvice parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryAdvisorResult.IndexAdvice
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<QueryAdvisorResult.IndexAdvice> parser()
Returns
Type Description
Parser<IndexAdvice>

Methods

equals(Object obj)

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

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

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.

getParserForType()

public Parser<QueryAdvisorResult.IndexAdvice> getParserForType()
Returns
Type Description
Parser<IndexAdvice>
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 QueryAdvisorResult.IndexAdvice.Builder newBuilderForType()
Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public QueryAdvisorResult.IndexAdvice.Builder toBuilder()
Returns
Type Description
QueryAdvisorResult.IndexAdvice.Builder

writeTo(CodedOutputStream output)

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