Package com.google.cloud.aiplatform.v1

Class ExamplesOverride.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ExamplesOverride.Builder>
com.google.cloud.aiplatform.v1.ExamplesOverride.Builder
All Implemented Interfaces:
ExamplesOverrideOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExamplesOverride
public static final class ExamplesOverride.Builder extends com.google.protobuf.GeneratedMessage.Builder<ExamplesOverride.Builder> implements ExamplesOverrideOrBuilder
 Overrides for example-based explanations.
Protobuf type google.cloud.aiplatform.v1.ExamplesOverride

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ExamplesOverride.Builder>

    • clear

      public ExamplesOverride.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.GeneratedMessage.Builder<ExamplesOverride.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.GeneratedMessage.Builder<ExamplesOverride.Builder>

    • getDefaultInstanceForType

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

    • build

      public ExamplesOverride build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ExamplesOverride buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ExamplesOverride.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<ExamplesOverride.Builder>

    • mergeFrom

      public ExamplesOverride.Builder mergeFrom(ExamplesOverride other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ExamplesOverride.Builder>

    • mergeFrom

      public ExamplesOverride.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<ExamplesOverride.Builder>
      Throws:
      IOException

    • getNeighborCount

      public int getNeighborCount()
       The number of neighbors to return.
      int32 neighbor_count = 1;
      Specified by:
      getNeighborCount in interface ExamplesOverrideOrBuilder
      Returns:
      The neighborCount.

    • setNeighborCount

      public ExamplesOverride.Builder setNeighborCount(int value)
       The number of neighbors to return.
      int32 neighbor_count = 1;
      Parameters:
      value - The neighborCount to set.
      Returns:
      This builder for chaining.

    • clearNeighborCount

      public ExamplesOverride.Builder clearNeighborCount()
       The number of neighbors to return.
      int32 neighbor_count = 1;
      Returns:
      This builder for chaining.

    • getCrowdingCount

      public int getCrowdingCount()
       The number of neighbors to return that have the same crowding tag.
      int32 crowding_count = 2;
      Specified by:
      getCrowdingCount in interface ExamplesOverrideOrBuilder
      Returns:
      The crowdingCount.

    • setCrowdingCount

      public ExamplesOverride.Builder setCrowdingCount(int value)
       The number of neighbors to return that have the same crowding tag.
      int32 crowding_count = 2;
      Parameters:
      value - The crowdingCount to set.
      Returns:
      This builder for chaining.

    • clearCrowdingCount

      public ExamplesOverride.Builder clearCrowdingCount()
       The number of neighbors to return that have the same crowding tag.
      int32 crowding_count = 2;
      Returns:
      This builder for chaining.

    • getRestrictionsList

      public List<ExamplesRestrictionsNamespace> getRestrictionsList()
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;
      Specified by:
      getRestrictionsList in interface ExamplesOverrideOrBuilder

    • getRestrictionsCount

      public int getRestrictionsCount()
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;
      Specified by:
      getRestrictionsCount in interface ExamplesOverrideOrBuilder

    • getRestrictions

      public ExamplesRestrictionsNamespace getRestrictions(int index)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;
      Specified by:
      getRestrictions in interface ExamplesOverrideOrBuilder

    • setRestrictions

      public ExamplesOverride.Builder setRestrictions(int index, ExamplesRestrictionsNamespace value)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • setRestrictions

      public ExamplesOverride.Builder setRestrictions(int index, ExamplesRestrictionsNamespace.Builder builderForValue)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • addRestrictions

      public ExamplesOverride.Builder addRestrictions(ExamplesRestrictionsNamespace value)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • addRestrictions

      public ExamplesOverride.Builder addRestrictions(int index, ExamplesRestrictionsNamespace value)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • addRestrictions

      public ExamplesOverride.Builder addRestrictions(ExamplesRestrictionsNamespace.Builder builderForValue)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • addRestrictions

      public ExamplesOverride.Builder addRestrictions(int index, ExamplesRestrictionsNamespace.Builder builderForValue)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • addAllRestrictions

      public ExamplesOverride.Builder addAllRestrictions(Iterable<? extends ExamplesRestrictionsNamespace> values)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • clearRestrictions

      public ExamplesOverride.Builder clearRestrictions()
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • removeRestrictions

      public ExamplesOverride.Builder removeRestrictions(int index)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • getRestrictionsBuilder

      public ExamplesRestrictionsNamespace.Builder getRestrictionsBuilder(int index)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • getRestrictionsOrBuilder

      public ExamplesRestrictionsNamespaceOrBuilder getRestrictionsOrBuilder(int index)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;
      Specified by:
      getRestrictionsOrBuilder in interface ExamplesOverrideOrBuilder

    • getRestrictionsOrBuilderList

      public List<? extends ExamplesRestrictionsNamespaceOrBuilder> getRestrictionsOrBuilderList()
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;
      Specified by:
      getRestrictionsOrBuilderList in interface ExamplesOverrideOrBuilder

    • addRestrictionsBuilder

      public ExamplesRestrictionsNamespace.Builder addRestrictionsBuilder()
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • addRestrictionsBuilder

      public ExamplesRestrictionsNamespace.Builder addRestrictionsBuilder(int index)
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • getRestrictionsBuilderList

      public List<ExamplesRestrictionsNamespace.Builder> getRestrictionsBuilderList()
       Restrict the resulting nearest neighbors to respect these constraints.
      repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

    • getReturnEmbeddings

      public boolean getReturnEmbeddings()
       If true, return the embeddings instead of neighbors.
      bool return_embeddings = 4;
      Specified by:
      getReturnEmbeddings in interface ExamplesOverrideOrBuilder
      Returns:
      The returnEmbeddings.

    • setReturnEmbeddings

      public ExamplesOverride.Builder setReturnEmbeddings(boolean value)
       If true, return the embeddings instead of neighbors.
      bool return_embeddings = 4;
      Parameters:
      value - The returnEmbeddings to set.
      Returns:
      This builder for chaining.

    • clearReturnEmbeddings

      public ExamplesOverride.Builder clearReturnEmbeddings()
       If true, return the embeddings instead of neighbors.
      bool return_embeddings = 4;
      Returns:
      This builder for chaining.

    • getDataFormatValue

      public int getDataFormatValue()
       The format of the data being provided with each call.
      .google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;
      Specified by:
      getDataFormatValue in interface ExamplesOverrideOrBuilder
      Returns:
      The enum numeric value on the wire for dataFormat.

    • setDataFormatValue

      public ExamplesOverride.Builder setDataFormatValue(int value)
       The format of the data being provided with each call.
      .google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;
      Parameters:
      value - The enum numeric value on the wire for dataFormat to set.
      Returns:
      This builder for chaining.

    • getDataFormat

      public ExamplesOverride.DataFormat getDataFormat()
       The format of the data being provided with each call.
      .google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;
      Specified by:
      getDataFormat in interface ExamplesOverrideOrBuilder
      Returns:
      The dataFormat.

    • setDataFormat

      public ExamplesOverride.Builder setDataFormat(ExamplesOverride.DataFormat value)
       The format of the data being provided with each call.
      .google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;
      Parameters:
      value - The dataFormat to set.
      Returns:
      This builder for chaining.

    • clearDataFormat

      public ExamplesOverride.Builder clearDataFormat()
       The format of the data being provided with each call.
      .google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;
      Returns:
      This builder for chaining.