Package com.google.cloud.visionai.v1

Class SearchAssetsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.SearchAssetsRequest
All Implemented Interfaces:
SearchAssetsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchAssetsRequest extends com.google.protobuf.GeneratedMessage implements SearchAssetsRequestOrBuilder
 Request message for SearchAssets.
Protobuf type google.cloud.visionai.v1.SearchAssetsRequest
See Also:

  • Field Details

    • SCHEMA_KEY_SORTING_STRATEGY_FIELD_NUMBER

      public static final int SCHEMA_KEY_SORTING_STRATEGY_FIELD_NUMBER
      See Also:

    • CORPUS_FIELD_NUMBER

      public static final int CORPUS_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • CONTENT_TIME_RANGES_FIELD_NUMBER

      public static final int CONTENT_TIME_RANGES_FIELD_NUMBER
      See Also:

    • CRITERIA_FIELD_NUMBER

      public static final int CRITERIA_FIELD_NUMBER
      See Also:

    • FACET_SELECTIONS_FIELD_NUMBER

      public static final int FACET_SELECTIONS_FIELD_NUMBER
      See Also:

    • RESULT_ANNOTATION_KEYS_FIELD_NUMBER

      public static final int RESULT_ANNOTATION_KEYS_FIELD_NUMBER
      See Also:

    • SEARCH_QUERY_FIELD_NUMBER

      public static final int SEARCH_QUERY_FIELD_NUMBER
      See Also:

  • 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

    • getSortSpecCase

      public SearchAssetsRequest.SortSpecCase getSortSpecCase()
      Specified by:
      getSortSpecCase in interface SearchAssetsRequestOrBuilder

    • hasSchemaKeySortingStrategy

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

    • getSchemaKeySortingStrategy

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

    • getSchemaKeySortingStrategyOrBuilder

      public SchemaKeySortingStrategyOrBuilder getSchemaKeySortingStrategyOrBuilder()
       Sort by the value under the data schema key.
      .google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;
      Specified by:
      getSchemaKeySortingStrategyOrBuilder in interface SearchAssetsRequestOrBuilder

    • getCorpus

      public 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) = { ... }
      Specified by:
      getCorpus in interface SearchAssetsRequestOrBuilder
      Returns:
      The corpus.

    • getCorpusBytes

      public 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) = { ... }
      Specified by:
      getCorpusBytes in interface SearchAssetsRequestOrBuilder
      Returns:
      The bytes for corpus.

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface SearchAssetsRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

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

    • getPageTokenBytes

      public 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;
      Specified by:
      getPageTokenBytes in interface SearchAssetsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • hasContentTimeRanges

      public 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;
      Specified by:
      hasContentTimeRanges in interface SearchAssetsRequestOrBuilder
      Returns:
      Whether the contentTimeRanges field is set.

    • getContentTimeRanges

      public 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;
      Specified by:
      getContentTimeRanges in interface SearchAssetsRequestOrBuilder
      Returns:
      The contentTimeRanges.

    • getContentTimeRangesOrBuilder

      public 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;
      Specified by:
      getContentTimeRangesOrBuilder in interface SearchAssetsRequestOrBuilder

    • getCriteriaList

      public List<Criteria> getCriteriaList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaList in interface SearchAssetsRequestOrBuilder

    • getCriteriaOrBuilderList

      public List<? extends CriteriaOrBuilder> getCriteriaOrBuilderList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaOrBuilderList in interface SearchAssetsRequestOrBuilder

    • getCriteriaCount

      public int getCriteriaCount()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaCount in interface SearchAssetsRequestOrBuilder

    • getCriteria

      public Criteria getCriteria(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteria in interface SearchAssetsRequestOrBuilder

    • getCriteriaOrBuilder

      public CriteriaOrBuilder getCriteriaOrBuilder(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaOrBuilder in interface SearchAssetsRequestOrBuilder

    • getFacetSelectionsList

      public 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;
      Specified by:
      getFacetSelectionsList in interface SearchAssetsRequestOrBuilder

    • getFacetSelectionsOrBuilderList

      public 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;
      Specified by:
      getFacetSelectionsOrBuilderList in interface SearchAssetsRequestOrBuilder

    • getFacetSelectionsCount

      public 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;
      Specified by:
      getFacetSelectionsCount in interface SearchAssetsRequestOrBuilder

    • getFacetSelections

      public 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;
      Specified by:
      getFacetSelections in interface SearchAssetsRequestOrBuilder

    • getFacetSelectionsOrBuilder

      public 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;
      Specified by:
      getFacetSelectionsOrBuilder in interface SearchAssetsRequestOrBuilder

    • getResultAnnotationKeysList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getResultAnnotationKeysList in interface SearchAssetsRequestOrBuilder
      Returns:
      A list containing the resultAnnotationKeys.

    • getResultAnnotationKeysCount

      public 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;
      Specified by:
      getResultAnnotationKeysCount in interface SearchAssetsRequestOrBuilder
      Returns:
      The count of resultAnnotationKeys.

    • getResultAnnotationKeys

      public 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;
      Specified by:
      getResultAnnotationKeys in interface SearchAssetsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The resultAnnotationKeys at the given index.

    • getResultAnnotationKeysBytes

      public 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;
      Specified by:
      getResultAnnotationKeysBytes in interface SearchAssetsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resultAnnotationKeys at the given index.

    • getSearchQuery

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

    • getSearchQueryBytes

      public 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;
      Specified by:
      getSearchQueryBytes in interface SearchAssetsRequestOrBuilder
      Returns:
      The bytes for searchQuery.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchAssetsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAssetsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAssetsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAssetsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAssetsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAssetsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAssetsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchAssetsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchAssetsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchAssetsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchAssetsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchAssetsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchAssetsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchAssetsRequest.Builder newBuilder()

    • newBuilder

      public static SearchAssetsRequest.Builder newBuilder(SearchAssetsRequest prototype)

    • toBuilder

      public SearchAssetsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchAssetsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchAssetsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchAssetsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchAssetsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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