Class SearchAssetsRequest (0.3.0)

public final class SearchAssetsRequest extends GeneratedMessageV3 implements SearchAssetsRequestOrBuilder

Request message for SearchAssets.

Protobuf type google.cloud.visionai.v1.SearchAssetsRequest

Static Fields

CONTENT_TIME_RANGES_FIELD_NUMBER

public static final int CONTENT_TIME_RANGES_FIELD_NUMBER
Field Value
Type Description
int

CORPUS_FIELD_NUMBER

public static final int CORPUS_FIELD_NUMBER
Field Value
Type Description
int

CRITERIA_FIELD_NUMBER

public static final int CRITERIA_FIELD_NUMBER
Field Value
Type Description
int

FACET_SELECTIONS_FIELD_NUMBER

public static final int FACET_SELECTIONS_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

RESULT_ANNOTATION_KEYS_FIELD_NUMBER

public static final int RESULT_ANNOTATION_KEYS_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_KEY_SORTING_STRATEGY_FIELD_NUMBER

public static final int SCHEMA_KEY_SORTING_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_QUERY_FIELD_NUMBER

public static final int SEARCH_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchAssetsRequest getDefaultInstance()
Returns
Type Description
SearchAssetsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchAssetsRequest.Builder newBuilder()
Returns
Type Description
SearchAssetsRequest.Builder

newBuilder(SearchAssetsRequest prototype)

public static SearchAssetsRequest.Builder newBuilder(SearchAssetsRequest prototype)
Parameter
Name Description
prototype SearchAssetsRequest
Returns
Type Description
SearchAssetsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchAssetsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchAssetsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchAssetsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchAssetsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchAssetsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchAssetsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchAssetsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchAssetsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchAssetsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchAssetsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchAssetsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchAssetsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchAssetsRequest> parser()
Returns
Type Description
Parser<SearchAssetsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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;

Returns
Type Description
DateTimeRangeArray

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;

Returns
Type Description
DateTimeRangeArrayOrBuilder

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) = { ... }

Returns
Type Description
String

The corpus.

getCorpusBytes()

public 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
Type Description
ByteString

The bytes for corpus.

getCriteria(int index)

public Criteria getCriteria(int index)

Criteria applied to search results.

repeated .google.cloud.visionai.v1.Criteria criteria = 4;

Parameter
Name Description
index int
Returns
Type Description
Criteria

getCriteriaCount()

public int getCriteriaCount()

Criteria applied to search results.

repeated .google.cloud.visionai.v1.Criteria criteria = 4;

Returns
Type Description
int

getCriteriaList()

public List<Criteria> getCriteriaList()

Criteria applied to search results.

repeated .google.cloud.visionai.v1.Criteria criteria = 4;

Returns
Type Description
List<Criteria>

getCriteriaOrBuilder(int index)

public CriteriaOrBuilder getCriteriaOrBuilder(int index)

Criteria applied to search results.

repeated .google.cloud.visionai.v1.Criteria criteria = 4;

Parameter
Name Description
index int
Returns
Type Description
CriteriaOrBuilder

getCriteriaOrBuilderList()

public List<? extends CriteriaOrBuilder> getCriteriaOrBuilderList()

Criteria applied to search results.

repeated .google.cloud.visionai.v1.Criteria criteria = 4;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.CriteriaOrBuilder>

getDefaultInstanceForType()

public SearchAssetsRequest getDefaultInstanceForType()
Returns
Type Description
SearchAssetsRequest

getFacetSelections(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
FacetGroup

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;

Returns
Type Description
int

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;

Returns
Type Description
List<FacetGroup>

getFacetSelectionsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
FacetGroupOrBuilder

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;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.FacetGroupOrBuilder>

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;

Returns
Type Description
int

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;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public 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
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<SearchAssetsRequest> getParserForType()
Returns
Type Description
Parser<SearchAssetsRequest>
Overrides

getResultAnnotationKeys(int index)

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;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The resultAnnotationKeys at the given index.

getResultAnnotationKeysBytes(int index)

public 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;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the resultAnnotationKeys at the given index.

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;

Returns
Type Description
int

The count of resultAnnotationKeys.

getResultAnnotationKeysList()

public 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;

Returns
Type Description
ProtocolStringList

A list containing the resultAnnotationKeys.

getSchemaKeySortingStrategy()

public SchemaKeySortingStrategy getSchemaKeySortingStrategy()

Sort by the value under the data schema key.

.google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;

Returns
Type Description
SchemaKeySortingStrategy

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;

Returns
Type Description
SchemaKeySortingStrategyOrBuilder

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;

Returns
Type Description
String

The searchQuery.

getSearchQueryBytes()

public 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
Type Description
ByteString

The bytes for searchQuery.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSortSpecCase()

public SearchAssetsRequest.SortSpecCase getSortSpecCase()
Returns
Type Description
SearchAssetsRequest.SortSpecCase

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;

Returns
Type Description
boolean

Whether the contentTimeRanges field is set.

hasSchemaKeySortingStrategy()

public boolean hasSchemaKeySortingStrategy()

Sort by the value under the data schema key.

.google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;

Returns
Type Description
boolean

Whether the schemaKeySortingStrategy field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchAssetsRequest.Builder newBuilderForType()
Returns
Type Description
SearchAssetsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchAssetsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchAssetsRequest.Builder toBuilder()
Returns
Type Description
SearchAssetsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException