Class: Google::Cloud::VisionAI::V1::SearchAssetsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/warehouse.rb

Overview

Request message for SearchAssets.

Instance Attribute Summary collapse

Instance Attribute Details

#content_time_ranges ⇒ ::Google::Cloud::VisionAI::V1::DateTimeRangeArray

Returns 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.

Returns:

  • (::Google::Cloud::VisionAI::V1::DateTimeRangeArray) —

    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.



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#corpus ⇒ ::String

Returns Required. The parent corpus to search. Format: projects/{project_id}/locations/{location_id}/corpora/{corpus_id}.

Returns:

  • (::String) —

    Required. The parent corpus to search. Format: projects/{project_id}/locations/{location_id}/corpora/{corpus_id}



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#criteria ⇒ ::Array<::Google::Cloud::VisionAI::V1::Criteria>

Returns Criteria applied to search results.

Returns:



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#facet_selections ⇒ ::Array<::Google::Cloud::VisionAI::V1::FacetGroup>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::VisionAI::V1::FacetGroup>) —

    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.



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.

Returns:

  • (::Integer) —

    The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns The continuation token to fetch the next page. If empty, it means it is fetching the first page.

Returns:

  • (::String) —

    The continuation token to fetch the next page. If empty, it means it is fetching the first page.



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#result_annotation_keys ⇒ ::Array<::String>

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.

Returns:

  • (::Array<::String>) —

    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.



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#schema_key_sorting_strategy ⇒ ::Google::Cloud::VisionAI::V1::SchemaKeySortingStrategy

Returns Sort by the value under the data schema key.

Returns:



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#search_query ⇒ ::String

Returns Global search query. Allows user to search assets without needing to specify which field the value belongs to.

Returns:

  • (::String) —

    Global search query. Allows user to search assets without needing to specify which field the value belongs to.



2648
2649
2650
2651
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2648

class SearchAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end