public static final class WarehouseGrpc.WarehouseBlockingStub extends AbstractBlockingStub<WarehouseGrpc.WarehouseBlockingStub>
A stub to allow clients to do synchronous rpc calls to service Warehouse.
Service that manages media content + metadata for streaming.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
WarehouseGrpc.WarehouseBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
addCollectionItem(AddCollectionItemRequest request)
public AddCollectionItemResponse addCollectionItem(AddCollectionItemRequest request)
Adds an item into a Collection.
analyzeAsset(AnalyzeAssetRequest request)
public Operation analyzeAsset(AnalyzeAssetRequest request)
Analyze asset to power search capability.
analyzeCorpus(AnalyzeCorpusRequest request)
public Operation analyzeCorpus(AnalyzeCorpusRequest request)
build(Channel channel, CallOptions callOptions)
protected WarehouseGrpc.WarehouseBlockingStub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
clipAsset(ClipAssetRequest request)
public ClipAssetResponse clipAsset(ClipAssetRequest request)
Supported by STREAM_VIDEO corpus type.
Generates clips for downloading. The api takes in a time range, and
generates a clip of the first content available after start_time and
before end_time, which may overflow beyond these bounds.
Returned clips are truncated if the total size of the clips are larger
than 100MB.
createAnnotation(CreateAnnotationRequest request)
public Annotation createAnnotation(CreateAnnotationRequest request)
Creates annotation inside asset.
createAsset(CreateAssetRequest request)
public Asset createAsset(CreateAssetRequest request)
Creates an asset inside corpus.
| Returns |
| Type |
Description |
Asset |
|
createCollection(CreateCollectionRequest request)
public Operation createCollection(CreateCollectionRequest request)
createCorpus(CreateCorpusRequest request)
public Operation createCorpus(CreateCorpusRequest request)
Creates a corpus inside a project.
createDataSchema(CreateDataSchemaRequest request)
public DataSchema createDataSchema(CreateDataSchemaRequest request)
Creates data schema inside corpus.
createIndex(CreateIndexRequest request)
public Operation createIndex(CreateIndexRequest request)
Creates an Index under the corpus.
createIndexEndpoint(CreateIndexEndpointRequest request)
public Operation createIndexEndpoint(CreateIndexEndpointRequest request)
Creates an IndexEndpoint.
createSearchConfig(CreateSearchConfigRequest request)
public SearchConfig createSearchConfig(CreateSearchConfigRequest request)
Creates a search configuration inside a corpus.
Please follow the rules below to create a valid CreateSearchConfigRequest.
--- General Rules ---
- Request.search_config_id must not be associated with an existing
SearchConfig.
- Request must contain at least one non-empty search_criteria_property or
facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- All mapped_fields must share the same semantic SearchConfig match
options.
For property-specific rules, please reference the comments for
FacetProperty and SearchCriteriaProperty.
createSearchHypernym(CreateSearchHypernymRequest request)
public SearchHypernym createSearchHypernym(CreateSearchHypernymRequest request)
Creates a SearchHypernym inside a corpus.
deleteAnnotation(DeleteAnnotationRequest request)
public Empty deleteAnnotation(DeleteAnnotationRequest request)
Deletes annotation inside asset.
| Returns |
| Type |
Description |
Empty |
|
deleteAsset(DeleteAssetRequest request)
public Operation deleteAsset(DeleteAssetRequest request)
Deletes asset inside corpus.
deleteCollection(DeleteCollectionRequest request)
public Operation deleteCollection(DeleteCollectionRequest request)
deleteCorpus(DeleteCorpusRequest request)
public Empty deleteCorpus(DeleteCorpusRequest request)
Deletes a corpus only if its empty.
Returns empty response.
| Returns |
| Type |
Description |
Empty |
|
deleteDataSchema(DeleteDataSchemaRequest request)
public Empty deleteDataSchema(DeleteDataSchemaRequest request)
Deletes data schema inside corpus.
| Returns |
| Type |
Description |
Empty |
|
deleteIndex(DeleteIndexRequest request)
public Operation deleteIndex(DeleteIndexRequest request)
Delete a single Index. In order to delete an index, the caller must
make sure that it is not deployed to any index endpoint.
deleteIndexEndpoint(DeleteIndexEndpointRequest request)
public Operation deleteIndexEndpoint(DeleteIndexEndpointRequest request)
Deletes an IndexEndpoint.
deleteSearchConfig(DeleteSearchConfigRequest request)
public Empty deleteSearchConfig(DeleteSearchConfigRequest request)
Deletes a search configuration inside a corpus.
For a DeleteSearchConfigRequest to be valid,
Request.search_configuration.name must already exist.
| Returns |
| Type |
Description |
Empty |
|
deleteSearchHypernym(DeleteSearchHypernymRequest request)
public Empty deleteSearchHypernym(DeleteSearchHypernymRequest request)
Deletes a SearchHypernym inside a corpus.
| Returns |
| Type |
Description |
Empty |
|
deployIndex(DeployIndexRequest request)
public Operation deployIndex(DeployIndexRequest request)
Deploys an Index to IndexEndpoint.
generateHlsUri(GenerateHlsUriRequest request)
public GenerateHlsUriResponse generateHlsUri(GenerateHlsUriRequest request)
Generates a uri for an HLS manifest. The api takes in a collection of time
ranges, and generates a URI for an HLS manifest that covers all the
requested time ranges.
generateRetrievalUrl(GenerateRetrievalUrlRequest request)
public GenerateRetrievalUrlResponse generateRetrievalUrl(GenerateRetrievalUrlRequest request)
Generates a signed url for downloading the asset.
For video warehouse, please see comment of UploadAsset about how to allow
retrieval of cloud storage files in a different project.
getAnnotation(GetAnnotationRequest request)
public Annotation getAnnotation(GetAnnotationRequest request)
Reads annotation inside asset.
getAsset(GetAssetRequest request)
public Asset getAsset(GetAssetRequest request)
Reads an asset inside corpus.
| Returns |
| Type |
Description |
Asset |
|
getCollection(GetCollectionRequest request)
public Collection getCollection(GetCollectionRequest request)
getCorpus(GetCorpusRequest request)
public Corpus getCorpus(GetCorpusRequest request)
Gets corpus details inside a project.
| Returns |
| Type |
Description |
Corpus |
|
getDataSchema(GetDataSchemaRequest request)
public DataSchema getDataSchema(GetDataSchemaRequest request)
Gets data schema inside corpus.
getIndex(GetIndexRequest request)
public Index getIndex(GetIndexRequest request)
Gets the details of a single Index under a Corpus.
| Returns |
| Type |
Description |
Index |
|
getIndexEndpoint(GetIndexEndpointRequest request)
public IndexEndpoint getIndexEndpoint(GetIndexEndpointRequest request)
getSearchConfig(GetSearchConfigRequest request)
public SearchConfig getSearchConfig(GetSearchConfigRequest request)
Gets a search configuration inside a corpus.
getSearchHypernym(GetSearchHypernymRequest request)
public SearchHypernym getSearchHypernym(GetSearchHypernymRequest request)
Gets a SearchHypernym inside a corpus.
importAssets(ImportAssetsRequest request)
public Operation importAssets(ImportAssetsRequest request)
Imports assets (images plus annotations) from a meta file on cloud storage.
Each row in the meta file is corresponding to an image (specified by a
cloud storage uri) and its annotations.
indexAsset(IndexAssetRequest request)
public Operation indexAsset(IndexAssetRequest request)
Index one asset for search.
Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
listAnnotations(ListAnnotationsRequest request)
public ListAnnotationsResponse listAnnotations(ListAnnotationsRequest request)
Lists a list of annotations inside asset.
listAssets(ListAssetsRequest request)
public ListAssetsResponse listAssets(ListAssetsRequest request)
Lists an list of assets inside corpus.
listCollections(ListCollectionsRequest request)
public ListCollectionsResponse listCollections(ListCollectionsRequest request)
Lists collections inside a corpus.
listCorpora(ListCorporaRequest request)
public ListCorporaResponse listCorpora(ListCorporaRequest request)
Lists all corpora in a project.
listDataSchemas(ListDataSchemasRequest request)
public ListDataSchemasResponse listDataSchemas(ListDataSchemasRequest request)
Lists a list of data schemas inside corpus.
listIndexEndpoints(ListIndexEndpointsRequest request)
public ListIndexEndpointsResponse listIndexEndpoints(ListIndexEndpointsRequest request)
Lists all IndexEndpoints in a project.
listIndexes(ListIndexesRequest request)
public ListIndexesResponse listIndexes(ListIndexesRequest request)
List all Indexes in a given Corpus.
listSearchConfigs(ListSearchConfigsRequest request)
public ListSearchConfigsResponse listSearchConfigs(ListSearchConfigsRequest request)
Lists all search configurations inside a corpus.
listSearchHypernyms(ListSearchHypernymsRequest request)
public ListSearchHypernymsResponse listSearchHypernyms(ListSearchHypernymsRequest request)
Lists SearchHypernyms inside a corpus.
removeCollectionItem(RemoveCollectionItemRequest request)
public RemoveCollectionItemResponse removeCollectionItem(RemoveCollectionItemRequest request)
Removes an item from a collection.
removeIndexAsset(RemoveIndexAssetRequest request)
public Operation removeIndexAsset(RemoveIndexAssetRequest request)
Remove one asset's index data for search.
Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
searchAssets(SearchAssetsRequest request)
public SearchAssetsResponse searchAssets(SearchAssetsRequest request)
searchIndexEndpoint(SearchIndexEndpointRequest request)
public SearchIndexEndpointResponse searchIndexEndpoint(SearchIndexEndpointRequest request)
Search a deployed index endpoint (IMAGE corpus type only).
undeployIndex(UndeployIndexRequest request)
public Operation undeployIndex(UndeployIndexRequest request)
Undeploys an Index from IndexEndpoint.
updateAnnotation(UpdateAnnotationRequest request)
public Annotation updateAnnotation(UpdateAnnotationRequest request)
Updates annotation inside asset.
updateAsset(UpdateAssetRequest request)
public Asset updateAsset(UpdateAssetRequest request)
Updates an asset inside corpus.
| Returns |
| Type |
Description |
Asset |
|
updateCollection(UpdateCollectionRequest request)
public Collection updateCollection(UpdateCollectionRequest request)
updateCorpus(UpdateCorpusRequest request)
public Corpus updateCorpus(UpdateCorpusRequest request)
Updates a corpus in a project.
| Returns |
| Type |
Description |
Corpus |
|
updateDataSchema(UpdateDataSchemaRequest request)
public DataSchema updateDataSchema(UpdateDataSchemaRequest request)
Updates data schema inside corpus.
updateIndex(UpdateIndexRequest request)
public Operation updateIndex(UpdateIndexRequest request)
Updates an Index under the corpus.
Users can perform a metadata-only update or trigger a full index rebuild
with different update_mask values.
updateIndexEndpoint(UpdateIndexEndpointRequest request)
public Operation updateIndexEndpoint(UpdateIndexEndpointRequest request)
Updates an IndexEndpoint.
updateSearchConfig(UpdateSearchConfigRequest request)
public SearchConfig updateSearchConfig(UpdateSearchConfigRequest request)
Updates a search configuration inside a corpus.
Please follow the rules below to create a valid UpdateSearchConfigRequest.
--- General Rules ---
- Request.search_configuration.name must already exist.
- Request must contain at least one non-empty search_criteria_property or
facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- All mapped_fields must share the same semantic SearchConfig match
options.
For property-specific rules, please reference the comments for
FacetProperty and SearchCriteriaProperty.
updateSearchHypernym(UpdateSearchHypernymRequest request)
public SearchHypernym updateSearchHypernym(UpdateSearchHypernymRequest request)
Updates a SearchHypernym inside a corpus.
uploadAsset(UploadAssetRequest request)
public Operation uploadAsset(UploadAssetRequest request)
Upload asset by specifing the asset Cloud Storage uri.
For video warehouse, it requires users who call this API have read access
to the cloud storage file. Once it is uploaded, it can be retrieved by
GenerateRetrievalUrl API which by default, only can retrieve cloud storage
files from the same project of the warehouse. To allow retrieval cloud
storage files that are in a separate project, it requires to find the
vision ai service account (Go to IAM, check checkbox to show "Include
Google-provided role grants", search for "Cloud Vision AI Service Agent")
and grant the read access of the cloud storage files to that service
account.
viewCollectionItems(ViewCollectionItemsRequest request)
public ViewCollectionItemsResponse viewCollectionItems(ViewCollectionItemsRequest request)
View items inside a collection.
viewIndexedAssets(ViewIndexedAssetsRequest request)
public ViewIndexedAssetsResponse viewIndexedAssets(ViewIndexedAssetsRequest request)
Lists assets inside an index.
