Class QueryAdvisorResult.IndexAdvice.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
com.google.spanner.v1.QueryAdvisorResult.IndexAdvice.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryAdvisorResult.IndexAdviceOrBuilder, Cloneable
Enclosing class:
QueryAdvisorResult.IndexAdvice

public static final class QueryAdvisorResult.IndexAdvice.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder> implements QueryAdvisorResult.IndexAdviceOrBuilder
 Recommendation to add new indexes to run queries more efficiently.
 
Protobuf type google.spanner.v1.QueryAdvisorResult.IndexAdvice
  • Method Details

    • 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.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • getDefaultInstanceForType

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

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

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

      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • setField

      public QueryAdvisorResult.IndexAdvice.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • clearField

      public QueryAdvisorResult.IndexAdvice.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • clearOneof

      public QueryAdvisorResult.IndexAdvice.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • setRepeatedField

      public QueryAdvisorResult.IndexAdvice.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • addRepeatedField

      public QueryAdvisorResult.IndexAdvice.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • mergeFrom

      public QueryAdvisorResult.IndexAdvice.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • mergeFrom

      public QueryAdvisorResult.IndexAdvice.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryAdvisorResult.IndexAdvice.Builder>
      Throws:
      IOException
    • 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.
    • setDdl

      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:
      index - The index to set the value at.
      value - The ddl to set.
      Returns:
      This builder for chaining.
    • addDdl

       Optional. DDL statements to add new indexes that will improve the query.
       
      repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The ddl to add.
      Returns:
      This builder for chaining.
    • addAllDdl

       Optional. DDL statements to add new indexes that will improve the query.
       
      repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The ddl to add.
      Returns:
      This builder for chaining.
    • clearDdl

       Optional. DDL statements to add new indexes that will improve the query.
       
      repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • addDdlBytes

      public QueryAdvisorResult.IndexAdvice.Builder addDdlBytes(com.google.protobuf.ByteString value)
       Optional. DDL statements to add new indexes that will improve the query.
       
      repeated string ddl = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the ddl to add.
      Returns:
      This builder for chaining.
    • 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.
    • setImprovementFactor

      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];
      Parameters:
      value - The improvementFactor to set.
      Returns:
      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:
      This builder for chaining.
    • setUnknownFields

      public final QueryAdvisorResult.IndexAdvice.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>
    • mergeUnknownFields

      public final QueryAdvisorResult.IndexAdvice.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAdvisorResult.IndexAdvice.Builder>