com.google.cloud.visionai.v1.FacetGroupOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/visionai/v1/warehouse.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.visionai.v1;

public interface FacetGroupOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.FacetGroup)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Unique id of the facet group.
   * 
   *
   * string facet_id = 1;
   *
   * @return The facetId.
   */
  java.lang.String getFacetId();
  /**
   *
   *
   *    * Unique id of the facet group.
   * 
   *
   * string facet_id = 1;
   *
   * @return The bytes for facetId.
   */
  com.google.protobuf.ByteString getFacetIdBytes();

  /**
   *
   *
   *    * Display name of the facet. To be used by UI for facet rendering.
   * 
   *
   * string display_name = 2;
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Display name of the facet. To be used by UI for facet rendering.
   * 
   *
   * string display_name = 2;
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * Buckets associated with the facet. E.g. for "Team" facet, the bucket
   * can be 49ers, patriots, etc.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
   */
  java.util.List getBucketsList();
  /**
   *
   *
   *    * Buckets associated with the facet. E.g. for "Team" facet, the bucket
   * can be 49ers, patriots, etc.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
   */
  com.google.cloud.visionai.v1.FacetBucket getBuckets(int index);
  /**
   *
   *
   *    * Buckets associated with the facet. E.g. for "Team" facet, the bucket
   * can be 49ers, patriots, etc.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
   */
  int getBucketsCount();
  /**
   *
   *
   *    * Buckets associated with the facet. E.g. for "Team" facet, the bucket
   * can be 49ers, patriots, etc.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
   */
  java.util.List
      getBucketsOrBuilderList();
  /**
   *
   *
   *    * Buckets associated with the facet. E.g. for "Team" facet, the bucket
   * can be 49ers, patriots, etc.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
   */
  com.google.cloud.visionai.v1.FacetBucketOrBuilder getBucketsOrBuilder(int index);

  /**
   *
   *
   *    * Facet bucket type.
   * 
   *
   * .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
   *
   * @return The enum numeric value on the wire for bucketType.
   */
  int getBucketTypeValue();
  /**
   *
   *
   *    * Facet bucket type.
   * 
   *
   * .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
   *
   * @return The bucketType.
   */
  com.google.cloud.visionai.v1.FacetBucketType getBucketType();

  /**
   *
   *
   *    * If true, return query matched annotations for this facet group's selection.
   * This option is only applicable for facets based on partition level
   * annotations. It supports the following facet values:
   *  - INTEGER
   *  - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)
   * 
   *
   * bool fetch_matched_annotations = 5;
   *
   * @return The fetchMatchedAnnotations.
   */
  boolean getFetchMatchedAnnotations();
}