Send feedback
Class QueryAdvisorResult.IndexAdvice (6.107.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static QueryAdvisorResult . IndexAdvice . Builder newBuilder ()
newBuilder(QueryAdvisorResult.IndexAdvice prototype)
public static QueryAdvisorResult . IndexAdvice . Builder newBuilder ( QueryAdvisorResult . IndexAdvice prototype )
public static QueryAdvisorResult . IndexAdvice parseDelimitedFrom ( InputStream input )
public static QueryAdvisorResult . IndexAdvice parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static QueryAdvisorResult . IndexAdvice parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryAdvisorResult . IndexAdvice parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static QueryAdvisorResult . IndexAdvice parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryAdvisorResult . IndexAdvice parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static QueryAdvisorResult . IndexAdvice parseFrom ( CodedInputStream input )
public static QueryAdvisorResult . IndexAdvice parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static QueryAdvisorResult . IndexAdvice parseFrom ( InputStream input )
public static QueryAdvisorResult . IndexAdvice parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static QueryAdvisorResult . IndexAdvice parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryAdvisorResult . IndexAdvice parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<QueryAdvisorResult . IndexAdvice > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
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()
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];
getDefaultInstanceForType()
public QueryAdvisorResult . IndexAdvice getDefaultInstanceForType ()
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public QueryAdvisorResult . IndexAdvice . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryAdvisorResult . IndexAdvice . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public QueryAdvisorResult . IndexAdvice . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-21 UTC."],[],[]]