com.google.cloud.visionai.v1.SearchAssetsRequestOrBuilder 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 SearchAssetsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.SearchAssetsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Sort by the value under the data schema key.
   * 
   *
   * .google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;
   * 
   *
   * @return Whether the schemaKeySortingStrategy field is set.
   */
  boolean hasSchemaKeySortingStrategy();
  /**
   *
   *
   *    * Sort by the value under the data schema key.
   * 
   *
   * .google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;
   * 
   *
   * @return The schemaKeySortingStrategy.
   */
  com.google.cloud.visionai.v1.SchemaKeySortingStrategy getSchemaKeySortingStrategy();
  /**
   *
   *
   *    * Sort by the value under the data schema key.
   * 
   *
   * .google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;
   * 
   */
  com.google.cloud.visionai.v1.SchemaKeySortingStrategyOrBuilder
      getSchemaKeySortingStrategyOrBuilder();

  /**
   *
   *
   *    * Required. The parent corpus to search.
   * Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'
   * 
   *
   * 
   * string corpus = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The corpus.
   */
  java.lang.String getCorpus();
  /**
   *
   *
   *    * Required. The parent corpus to search.
   * Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'
   * 
   *
   * 
   * string corpus = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for corpus.
   */
  com.google.protobuf.ByteString getCorpusBytes();

  /**
   *
   *
   *    * The number of results to be returned in this page. If it's 0, the server
   * will decide the appropriate page_size.
   * 
   *
   * int32 page_size = 2;
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   *    * The continuation token to fetch the next page. If empty, it means it is
   * fetching the first page.
   * 
   *
   * string page_token = 3;
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * The continuation token to fetch the next page. If empty, it means it is
   * fetching the first page.
   * 
   *
   * string page_token = 3;
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   *    * Time ranges that matching video content must fall within. If no ranges are
   * provided, there will be no time restriction. This field is treated just
   * like the criteria below, but defined separately for convenience as it is
   * used frequently. Note that if the end_time is in the future, it will be
   * clamped to the time the request was received.
   * 
   *
   * .google.cloud.visionai.v1.DateTimeRangeArray content_time_ranges = 5;
   *
   * @return Whether the contentTimeRanges field is set.
   */
  boolean hasContentTimeRanges();
  /**
   *
   *
   *    * Time ranges that matching video content must fall within. If no ranges are
   * provided, there will be no time restriction. This field is treated just
   * like the criteria below, but defined separately for convenience as it is
   * used frequently. Note that if the end_time is in the future, it will be
   * clamped to the time the request was received.
   * 
   *
   * .google.cloud.visionai.v1.DateTimeRangeArray content_time_ranges = 5;
   *
   * @return The contentTimeRanges.
   */
  com.google.cloud.visionai.v1.DateTimeRangeArray getContentTimeRanges();
  /**
   *
   *
   *    * Time ranges that matching video content must fall within. If no ranges are
   * provided, there will be no time restriction. This field is treated just
   * like the criteria below, but defined separately for convenience as it is
   * used frequently. Note that if the end_time is in the future, it will be
   * clamped to the time the request was received.
   * 
   *
   * .google.cloud.visionai.v1.DateTimeRangeArray content_time_ranges = 5;
   */
  com.google.cloud.visionai.v1.DateTimeRangeArrayOrBuilder getContentTimeRangesOrBuilder();

  /**
   *
   *
   *    * Criteria applied to search results.
   * 
   *
   * repeated .google.cloud.visionai.v1.Criteria criteria = 4;
   */
  java.util.List getCriteriaList();
  /**
   *
   *
   *    * Criteria applied to search results.
   * 
   *
   * repeated .google.cloud.visionai.v1.Criteria criteria = 4;
   */
  com.google.cloud.visionai.v1.Criteria getCriteria(int index);
  /**
   *
   *
   *    * Criteria applied to search results.
   * 
   *
   * repeated .google.cloud.visionai.v1.Criteria criteria = 4;
   */
  int getCriteriaCount();
  /**
   *
   *
   *    * Criteria applied to search results.
   * 
   *
   * repeated .google.cloud.visionai.v1.Criteria criteria = 4;
   */
  java.util.List
      getCriteriaOrBuilderList();
  /**
   *
   *
   *    * Criteria applied to search results.
   * 
   *
   * repeated .google.cloud.visionai.v1.Criteria criteria = 4;
   */
  com.google.cloud.visionai.v1.CriteriaOrBuilder getCriteriaOrBuilder(int index);

  /**
   *
   *
   *    * Stores most recent facet selection state. Only facet groups with user's
   * selection will be presented here. Selection state is either selected or
   * unselected. Only selected facet buckets will be used as search criteria.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;
   */
  java.util.List getFacetSelectionsList();
  /**
   *
   *
   *    * Stores most recent facet selection state. Only facet groups with user's
   * selection will be presented here. Selection state is either selected or
   * unselected. Only selected facet buckets will be used as search criteria.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;
   */
  com.google.cloud.visionai.v1.FacetGroup getFacetSelections(int index);
  /**
   *
   *
   *    * Stores most recent facet selection state. Only facet groups with user's
   * selection will be presented here. Selection state is either selected or
   * unselected. Only selected facet buckets will be used as search criteria.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;
   */
  int getFacetSelectionsCount();
  /**
   *
   *
   *    * Stores most recent facet selection state. Only facet groups with user's
   * selection will be presented here. Selection state is either selected or
   * unselected. Only selected facet buckets will be used as search criteria.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;
   */
  java.util.List
      getFacetSelectionsOrBuilderList();
  /**
   *
   *
   *    * Stores most recent facet selection state. Only facet groups with user's
   * selection will be presented here. Selection state is either selected or
   * unselected. Only selected facet buckets will be used as search criteria.
   * 
   *
   * repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;
   */
  com.google.cloud.visionai.v1.FacetGroupOrBuilder getFacetSelectionsOrBuilder(int index);

  /**
   *
   *
   *    * A list of annotation keys to specify the annotations to be retrieved and
   * returned with each search result.
   * Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search
   * strategy must not be NO_SEARCH.
   * 
   *
   * repeated string result_annotation_keys = 8;
   *
   * @return A list containing the resultAnnotationKeys.
   */
  java.util.List getResultAnnotationKeysList();
  /**
   *
   *
   *    * A list of annotation keys to specify the annotations to be retrieved and
   * returned with each search result.
   * Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search
   * strategy must not be NO_SEARCH.
   * 
   *
   * repeated string result_annotation_keys = 8;
   *
   * @return The count of resultAnnotationKeys.
   */
  int getResultAnnotationKeysCount();
  /**
   *
   *
   *    * A list of annotation keys to specify the annotations to be retrieved and
   * returned with each search result.
   * Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search
   * strategy must not be NO_SEARCH.
   * 
   *
   * repeated string result_annotation_keys = 8;
   *
   * @param index The index of the element to return.
   * @return The resultAnnotationKeys at the given index.
   */
  java.lang.String getResultAnnotationKeys(int index);
  /**
   *
   *
   *    * A list of annotation keys to specify the annotations to be retrieved and
   * returned with each search result.
   * Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search
   * strategy must not be NO_SEARCH.
   * 
   *
   * repeated string result_annotation_keys = 8;
   *
   * @param index The index of the value to return.
   * @return The bytes of the resultAnnotationKeys at the given index.
   */
  com.google.protobuf.ByteString getResultAnnotationKeysBytes(int index);

  /**
   *
   *
   *    * Global search query. Allows user to search assets without needing to
   * specify which field the value belongs to.
   * 
   *
   * string search_query = 10;
   *
   * @return The searchQuery.
   */
  java.lang.String getSearchQuery();
  /**
   *
   *
   *    * Global search query. Allows user to search assets without needing to
   * specify which field the value belongs to.
   * 
   *
   * string search_query = 10;
   *
   * @return The bytes for searchQuery.
   */
  com.google.protobuf.ByteString getSearchQueryBytes();

  com.google.cloud.visionai.v1.SearchAssetsRequest.SortSpecCase getSortSpecCase();
}