Package com.google.spanner.v1

Class QueryAdvisorResult.IndexAdvice

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.QueryAdvisorResult.IndexAdvice
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryAdvisorResult.IndexAdviceOrBuilder, Serializable
Enclosing class:
QueryAdvisorResult
public static final class QueryAdvisorResult.IndexAdvice extends com.google.protobuf.GeneratedMessageV3 implements QueryAdvisorResult.IndexAdviceOrBuilder
 Recommendation to add new indexes to run queries more efficiently.
Protobuf type google.spanner.v1.QueryAdvisorResult.IndexAdvice
See Also:

  • Field Details

    • DDL_FIELD_NUMBER

      public static final int DDL_FIELD_NUMBER
      See Also:

    • IMPROVEMENT_FACTOR_FIELD_NUMBER

      public static final int IMPROVEMENT_FACTOR_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getDdlList

      public com.google.protobuf.ProtocolStringList getDdlList()
       Optional. DDL statements to add new indexes that will improve the query.
      repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDdlList in interface QueryAdvisorResult.IndexAdviceOrBuilder
      Returns:
      A list containing the ddl.

    • 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];
      Specified by:
      getDdlCount in interface QueryAdvisorResult.IndexAdviceOrBuilder
      Returns:
      The count of ddl.

    • getDdl

      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];
      Specified by:
      getDdl in interface QueryAdvisorResult.IndexAdviceOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The ddl at the given index.

    • getDdlBytes

      public com.google.protobuf.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];
      Specified by:
      getDdlBytes in interface QueryAdvisorResult.IndexAdviceOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ddl at the given index.

    • 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];
      Specified by:
      getImprovementFactor in interface QueryAdvisorResult.IndexAdviceOrBuilder
      Returns:
      The improvementFactor.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryAdvisorResult.IndexAdvice parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryAdvisorResult.IndexAdvice parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryAdvisorResult.IndexAdvice parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public QueryAdvisorResult.IndexAdvice.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static QueryAdvisorResult.IndexAdvice.Builder newBuilder()

    • newBuilder

      public static QueryAdvisorResult.IndexAdvice.Builder newBuilder(QueryAdvisorResult.IndexAdvice prototype)

    • toBuilder

      public QueryAdvisorResult.IndexAdvice.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected QueryAdvisorResult.IndexAdvice.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static QueryAdvisorResult.IndexAdvice getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<QueryAdvisorResult.IndexAdvice> parser()

    • getParserForType

      public com.google.protobuf.Parser<QueryAdvisorResult.IndexAdvice> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public QueryAdvisorResult.IndexAdvice getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder