Package com.google.cloud.visionai.v1

Class FacetProperty.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FacetProperty.Builder>
com.google.cloud.visionai.v1.FacetProperty.Builder
All Implemented Interfaces:
FacetPropertyOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
FacetProperty
public static final class FacetProperty.Builder extends com.google.protobuf.GeneratedMessage.Builder<FacetProperty.Builder> implements FacetPropertyOrBuilder
 Central configuration for a facet.
Protobuf type google.cloud.visionai.v1.FacetProperty

  • 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<FacetProperty.Builder>

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public FacetProperty.Builder mergeFrom(FacetProperty other)

    • isInitialized

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

    • mergeFrom

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

    • getRangeFacetConfigCase

      public FacetProperty.RangeFacetConfigCase getRangeFacetConfigCase()
      Specified by:
      getRangeFacetConfigCase in interface FacetPropertyOrBuilder

    • clearRangeFacetConfig

      public FacetProperty.Builder clearRangeFacetConfig()

    • hasFixedRangeBucketSpec

      public boolean hasFixedRangeBucketSpec()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
      Specified by:
      hasFixedRangeBucketSpec in interface FacetPropertyOrBuilder
      Returns:
      Whether the fixedRangeBucketSpec field is set.

    • getFixedRangeBucketSpec

      public FacetProperty.FixedRangeBucketSpec getFixedRangeBucketSpec()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
      Specified by:
      getFixedRangeBucketSpec in interface FacetPropertyOrBuilder
      Returns:
      The fixedRangeBucketSpec.

    • setFixedRangeBucketSpec

      public FacetProperty.Builder setFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec value)
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;

    • setFixedRangeBucketSpec

      public FacetProperty.Builder setFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec.Builder builderForValue)
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;

    • mergeFixedRangeBucketSpec

      public FacetProperty.Builder mergeFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec value)
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;

    • clearFixedRangeBucketSpec

      public FacetProperty.Builder clearFixedRangeBucketSpec()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;

    • getFixedRangeBucketSpecBuilder

      public FacetProperty.FixedRangeBucketSpec.Builder getFixedRangeBucketSpecBuilder()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;

    • getFixedRangeBucketSpecOrBuilder

      public FacetProperty.FixedRangeBucketSpecOrBuilder getFixedRangeBucketSpecOrBuilder()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
      Specified by:
      getFixedRangeBucketSpecOrBuilder in interface FacetPropertyOrBuilder

    • hasCustomRangeBucketSpec

      public boolean hasCustomRangeBucketSpec()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
      Specified by:
      hasCustomRangeBucketSpec in interface FacetPropertyOrBuilder
      Returns:
      Whether the customRangeBucketSpec field is set.

    • getCustomRangeBucketSpec

      public FacetProperty.CustomRangeBucketSpec getCustomRangeBucketSpec()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
      Specified by:
      getCustomRangeBucketSpec in interface FacetPropertyOrBuilder
      Returns:
      The customRangeBucketSpec.

    • setCustomRangeBucketSpec

      public FacetProperty.Builder setCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec value)
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;

    • setCustomRangeBucketSpec

      public FacetProperty.Builder setCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec.Builder builderForValue)
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;

    • mergeCustomRangeBucketSpec

      public FacetProperty.Builder mergeCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec value)
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;

    • clearCustomRangeBucketSpec

      public FacetProperty.Builder clearCustomRangeBucketSpec()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;

    • getCustomRangeBucketSpecBuilder

      public FacetProperty.CustomRangeBucketSpec.Builder getCustomRangeBucketSpecBuilder()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;

    • getCustomRangeBucketSpecOrBuilder

      public FacetProperty.CustomRangeBucketSpecOrBuilder getCustomRangeBucketSpecOrBuilder()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
      Specified by:
      getCustomRangeBucketSpecOrBuilder in interface FacetPropertyOrBuilder

    • hasDatetimeBucketSpec

      public boolean hasDatetimeBucketSpec()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
      Specified by:
      hasDatetimeBucketSpec in interface FacetPropertyOrBuilder
      Returns:
      Whether the datetimeBucketSpec field is set.

    • getDatetimeBucketSpec

      public FacetProperty.DateTimeBucketSpec getDatetimeBucketSpec()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
      Specified by:
      getDatetimeBucketSpec in interface FacetPropertyOrBuilder
      Returns:
      The datetimeBucketSpec.

    • setDatetimeBucketSpec

      public FacetProperty.Builder setDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec value)
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;

    • setDatetimeBucketSpec

      public FacetProperty.Builder setDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec.Builder builderForValue)
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;

    • mergeDatetimeBucketSpec

      public FacetProperty.Builder mergeDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec value)
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;

    • clearDatetimeBucketSpec

      public FacetProperty.Builder clearDatetimeBucketSpec()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;

    • getDatetimeBucketSpecBuilder

      public FacetProperty.DateTimeBucketSpec.Builder getDatetimeBucketSpecBuilder()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;

    • getDatetimeBucketSpecOrBuilder

      public FacetProperty.DateTimeBucketSpecOrBuilder getDatetimeBucketSpecOrBuilder()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
      Specified by:
      getDatetimeBucketSpecOrBuilder in interface FacetPropertyOrBuilder

    • getMappedFieldsList

      public com.google.protobuf.ProtocolStringList getMappedFieldsList()
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Specified by:
      getMappedFieldsList in interface FacetPropertyOrBuilder
      Returns:
      A list containing the mappedFields.

    • getMappedFieldsCount

      public int getMappedFieldsCount()
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Specified by:
      getMappedFieldsCount in interface FacetPropertyOrBuilder
      Returns:
      The count of mappedFields.

    • getMappedFields

      public String getMappedFields(int index)
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Specified by:
      getMappedFields in interface FacetPropertyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The mappedFields at the given index.

    • getMappedFieldsBytes

      public com.google.protobuf.ByteString getMappedFieldsBytes(int index)
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Specified by:
      getMappedFieldsBytes in interface FacetPropertyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the mappedFields at the given index.

    • setMappedFields

      public FacetProperty.Builder setMappedFields(int index, String value)
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Parameters:
      index - The index to set the value at.
      value - The mappedFields to set.
      Returns:
      This builder for chaining.

    • addMappedFields

      public FacetProperty.Builder addMappedFields(String value)
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Parameters:
      value - The mappedFields to add.
      Returns:
      This builder for chaining.

    • addAllMappedFields

      public FacetProperty.Builder addAllMappedFields(Iterable<String> values)
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Parameters:
      values - The mappedFields to add.
      Returns:
      This builder for chaining.

    • clearMappedFields

      public FacetProperty.Builder clearMappedFields()
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Returns:
      This builder for chaining.

    • addMappedFieldsBytes

      public FacetProperty.Builder addMappedFieldsBytes(com.google.protobuf.ByteString value)
       Name of the facets, which are the dimensions users want to use to refine
 search results. `mapped_fields` will match UserSpecifiedDataSchema keys.

 For example, user can add a bunch of UGAs with the same key, such as
 player:adam, player:bob, player:charles. When multiple mapped_fields are
 specified, will merge their value together as final facet value. E.g.
 home_team: a, home_team:b, away_team:a, away_team:c, when facet_field =
 [home_team, away_team], facet_value will be [a, b, c].

 UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the
 mapped_field equals the parent SearchConfig.name, the parent must
 also contain a SearchCriteriaProperty that maps to the same fields.
 mapped_fields must not be empty.
      repeated string mapped_fields = 1;
      Parameters:
      value - The bytes of the mappedFields to add.
      Returns:
      This builder for chaining.

    • getDisplayName

      public String getDisplayName()
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Specified by:
      getDisplayName in interface FacetPropertyOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface FacetPropertyOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public FacetProperty.Builder setDisplayName(String value)
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public FacetProperty.Builder clearDisplayName()
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public FacetProperty.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getResultSize

      public long getResultSize()
       Maximum number of unique bucket to return for one facet. Bucket number can
 be large for high-cardinality facet such as "player". We only return top-n
 most related ones to user. If it's <= 0, the server will decide the
 appropriate result_size.
      int64 result_size = 3;
      Specified by:
      getResultSize in interface FacetPropertyOrBuilder
      Returns:
      The resultSize.

    • setResultSize

      public FacetProperty.Builder setResultSize(long value)
       Maximum number of unique bucket to return for one facet. Bucket number can
 be large for high-cardinality facet such as "player". We only return top-n
 most related ones to user. If it's <= 0, the server will decide the
 appropriate result_size.
      int64 result_size = 3;
      Parameters:
      value - The resultSize to set.
      Returns:
      This builder for chaining.

    • clearResultSize

      public FacetProperty.Builder clearResultSize()
       Maximum number of unique bucket to return for one facet. Bucket number can
 be large for high-cardinality facet such as "player". We only return top-n
 most related ones to user. If it's <= 0, the server will decide the
 appropriate result_size.
      int64 result_size = 3;
      Returns:
      This builder for chaining.

    • getBucketTypeValue

      public int getBucketTypeValue()
       Facet bucket type e.g. value, range.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Specified by:
      getBucketTypeValue in interface FacetPropertyOrBuilder
      Returns:
      The enum numeric value on the wire for bucketType.

    • setBucketTypeValue

      public FacetProperty.Builder setBucketTypeValue(int value)
       Facet bucket type e.g. value, range.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Parameters:
      value - The enum numeric value on the wire for bucketType to set.
      Returns:
      This builder for chaining.

    • getBucketType

      public FacetBucketType getBucketType()
       Facet bucket type e.g. value, range.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Specified by:
      getBucketType in interface FacetPropertyOrBuilder
      Returns:
      The bucketType.

    • setBucketType

      public FacetProperty.Builder setBucketType(FacetBucketType value)
       Facet bucket type e.g. value, range.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Parameters:
      value - The bucketType to set.
      Returns:
      This builder for chaining.

    • clearBucketType

      public FacetProperty.Builder clearBucketType()
       Facet bucket type e.g. value, range.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Returns:
      This builder for chaining.