Package com.google.cloud.visionai.v1

Interface SearchAssetsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchAssetsRequest, SearchAssetsRequest.Builder
@Generated public interface SearchAssetsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasSchemaKeySortingStrategy

      boolean hasSchemaKeySortingStrategy()
       Sort by the value under the data schema key.
      .google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;
      Returns:
      Whether the schemaKeySortingStrategy field is set.

    • getSchemaKeySortingStrategy

      SchemaKeySortingStrategy getSchemaKeySortingStrategy()
       Sort by the value under the data schema key.
      .google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;
      Returns:
      The schemaKeySortingStrategy.

    • getSchemaKeySortingStrategyOrBuilder

      SchemaKeySortingStrategyOrBuilder getSchemaKeySortingStrategyOrBuilder()
       Sort by the value under the data schema key.
      .google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;

    • getCorpus

      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) = { ... }
      Returns:
      The corpus.

    • getCorpusBytes

      com.google.protobuf.ByteString getCorpusBytes()
       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) = { ... }
      Returns:
      The bytes for corpus.

    • getPageSize

      int getPageSize()
       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;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       The continuation token to fetch the next page. If empty, it means it is
 fetching the first page.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       The continuation token to fetch the next page. If empty, it means it is
 fetching the first page.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • hasContentTimeRanges

      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;
      Returns:
      Whether the contentTimeRanges field is set.

    • getContentTimeRanges

      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;
      Returns:
      The contentTimeRanges.

    • getContentTimeRangesOrBuilder

      DateTimeRangeArrayOrBuilder getContentTimeRangesOrBuilder()
       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;

    • getCriteriaList

      List<Criteria> getCriteriaList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getCriteria

      Criteria getCriteria(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getCriteriaCount

      int getCriteriaCount()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getCriteriaOrBuilderList

      List<? extends CriteriaOrBuilder> getCriteriaOrBuilderList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getCriteriaOrBuilder

      CriteriaOrBuilder getCriteriaOrBuilder(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getFacetSelectionsList

      List<FacetGroup> 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;

    • getFacetSelections

      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;

    • getFacetSelectionsCount

      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;

    • getFacetSelectionsOrBuilderList

      List<? extends FacetGroupOrBuilder> 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;

    • getFacetSelectionsOrBuilder

      FacetGroupOrBuilder getFacetSelectionsOrBuilder(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;

    • getResultAnnotationKeysList

      List<String> 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;
      Returns:
      A list containing the resultAnnotationKeys.

    • getResultAnnotationKeysCount

      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;
      Returns:
      The count of resultAnnotationKeys.

    • getResultAnnotationKeys

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The resultAnnotationKeys at the given index.

    • getResultAnnotationKeysBytes

      com.google.protobuf.ByteString getResultAnnotationKeysBytes(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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resultAnnotationKeys at the given index.

    • getSearchQuery

      String getSearchQuery()
       Global search query. Allows user to search assets without needing to
 specify which field the value belongs to.
      string search_query = 10;
      Returns:
      The searchQuery.

    • getSearchQueryBytes

      com.google.protobuf.ByteString getSearchQueryBytes()
       Global search query. Allows user to search assets without needing to
 specify which field the value belongs to.
      string search_query = 10;
      Returns:
      The bytes for searchQuery.

    • getSortSpecCase

      SearchAssetsRequest.SortSpecCase getSortSpecCase()