public static final class WarehouseGrpc.WarehouseStub extends AbstractAsyncStub<WarehouseGrpc.WarehouseStub>
A stub to allow clients to do asynchronous rpc calls to service Warehouse.
Service that manages media content + metadata for streaming.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractAsyncStub >
WarehouseGrpc.WarehouseStub
Inherited Members
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractAsyncStub.<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(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, StreamObserver<AddCollectionItemResponse> responseObserver)
public void addCollectionItem(AddCollectionItemRequest request, StreamObserver<AddCollectionItemResponse> responseObserver)
Adds an item into a Collection.
analyzeAsset(AnalyzeAssetRequest request, StreamObserver<Operation> responseObserver)
public void analyzeAsset(AnalyzeAssetRequest request, StreamObserver<Operation> responseObserver)
Analyze asset to power search capability.
analyzeCorpus(AnalyzeCorpusRequest request, StreamObserver<Operation> responseObserver)
public void analyzeCorpus(AnalyzeCorpusRequest request, StreamObserver<Operation> responseObserver)
build(Channel channel, CallOptions callOptions)
protected WarehouseGrpc.WarehouseStub 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, StreamObserver<ClipAssetResponse> responseObserver)
public void clipAsset(ClipAssetRequest request, StreamObserver<ClipAssetResponse> responseObserver)
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, StreamObserver<Annotation> responseObserver)
public void createAnnotation(CreateAnnotationRequest request, StreamObserver<Annotation> responseObserver)
Creates annotation inside asset.
createAsset(CreateAssetRequest request, StreamObserver<Asset> responseObserver)
public void createAsset(CreateAssetRequest request, StreamObserver<Asset> responseObserver)
Creates an asset inside corpus.
createCollection(CreateCollectionRequest request, StreamObserver<Operation> responseObserver)
public void createCollection(CreateCollectionRequest request, StreamObserver<Operation> responseObserver)
createCorpus(CreateCorpusRequest request, StreamObserver<Operation> responseObserver)
public void createCorpus(CreateCorpusRequest request, StreamObserver<Operation> responseObserver)
Creates a corpus inside a project.
createDataSchema(CreateDataSchemaRequest request, StreamObserver<DataSchema> responseObserver)
public void createDataSchema(CreateDataSchemaRequest request, StreamObserver<DataSchema> responseObserver)
Creates data schema inside corpus.
createIndex(CreateIndexRequest request, StreamObserver<Operation> responseObserver)
public void createIndex(CreateIndexRequest request, StreamObserver<Operation> responseObserver)
Creates an Index under the corpus.
createIndexEndpoint(CreateIndexEndpointRequest request, StreamObserver<Operation> responseObserver)
public void createIndexEndpoint(CreateIndexEndpointRequest request, StreamObserver<Operation> responseObserver)
Creates an IndexEndpoint.
createSearchConfig(CreateSearchConfigRequest request, StreamObserver<SearchConfig> responseObserver)
public void createSearchConfig(CreateSearchConfigRequest request, StreamObserver<SearchConfig> responseObserver)
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, StreamObserver<SearchHypernym> responseObserver)
public void createSearchHypernym(CreateSearchHypernymRequest request, StreamObserver<SearchHypernym> responseObserver)
Creates a SearchHypernym inside a corpus.
deleteAnnotation(DeleteAnnotationRequest request, StreamObserver<Empty> responseObserver)
public void deleteAnnotation(DeleteAnnotationRequest request, StreamObserver<Empty> responseObserver)
Deletes annotation inside asset.
deleteAsset(DeleteAssetRequest request, StreamObserver<Operation> responseObserver)
public void deleteAsset(DeleteAssetRequest request, StreamObserver<Operation> responseObserver)
Deletes asset inside corpus.
deleteCollection(DeleteCollectionRequest request, StreamObserver<Operation> responseObserver)
public void deleteCollection(DeleteCollectionRequest request, StreamObserver<Operation> responseObserver)
deleteCorpus(DeleteCorpusRequest request, StreamObserver<Empty> responseObserver)
public void deleteCorpus(DeleteCorpusRequest request, StreamObserver<Empty> responseObserver)
Deletes a corpus only if its empty.
Returns empty response.
deleteDataSchema(DeleteDataSchemaRequest request, StreamObserver<Empty> responseObserver)
public void deleteDataSchema(DeleteDataSchemaRequest request, StreamObserver<Empty> responseObserver)
Deletes data schema inside corpus.
deleteIndex(DeleteIndexRequest request, StreamObserver<Operation> responseObserver)
public void deleteIndex(DeleteIndexRequest request, StreamObserver<Operation> responseObserver)
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, StreamObserver<Operation> responseObserver)
public void deleteIndexEndpoint(DeleteIndexEndpointRequest request, StreamObserver<Operation> responseObserver)
Deletes an IndexEndpoint.
deleteSearchConfig(DeleteSearchConfigRequest request, StreamObserver<Empty> responseObserver)
public void deleteSearchConfig(DeleteSearchConfigRequest request, StreamObserver<Empty> responseObserver)
Deletes a search configuration inside a corpus.
For a DeleteSearchConfigRequest to be valid,
Request.search_configuration.name must already exist.
deleteSearchHypernym(DeleteSearchHypernymRequest request, StreamObserver<Empty> responseObserver)
public void deleteSearchHypernym(DeleteSearchHypernymRequest request, StreamObserver<Empty> responseObserver)
Deletes a SearchHypernym inside a corpus.
deployIndex(DeployIndexRequest request, StreamObserver<Operation> responseObserver)
public void deployIndex(DeployIndexRequest request, StreamObserver<Operation> responseObserver)
Deploys an Index to IndexEndpoint.
generateHlsUri(GenerateHlsUriRequest request, StreamObserver<GenerateHlsUriResponse> responseObserver)
public void generateHlsUri(GenerateHlsUriRequest request, StreamObserver<GenerateHlsUriResponse> responseObserver)
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, StreamObserver<GenerateRetrievalUrlResponse> responseObserver)
public void generateRetrievalUrl(GenerateRetrievalUrlRequest request, StreamObserver<GenerateRetrievalUrlResponse> responseObserver)
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, StreamObserver<Annotation> responseObserver)
public void getAnnotation(GetAnnotationRequest request, StreamObserver<Annotation> responseObserver)
Reads annotation inside asset.
getAsset(GetAssetRequest request, StreamObserver<Asset> responseObserver)
public void getAsset(GetAssetRequest request, StreamObserver<Asset> responseObserver)
Reads an asset inside corpus.
Parameters |
Name |
Description |
request |
GetAssetRequest
|
responseObserver |
io.grpc.stub.StreamObserver<Asset>
|
getCollection(GetCollectionRequest request, StreamObserver<Collection> responseObserver)
public void getCollection(GetCollectionRequest request, StreamObserver<Collection> responseObserver)
getCorpus(GetCorpusRequest request, StreamObserver<Corpus> responseObserver)
public void getCorpus(GetCorpusRequest request, StreamObserver<Corpus> responseObserver)
Gets corpus details inside a project.
getDataSchema(GetDataSchemaRequest request, StreamObserver<DataSchema> responseObserver)
public void getDataSchema(GetDataSchemaRequest request, StreamObserver<DataSchema> responseObserver)
Gets data schema inside corpus.
getIndex(GetIndexRequest request, StreamObserver<Index> responseObserver)
public void getIndex(GetIndexRequest request, StreamObserver<Index> responseObserver)
Gets the details of a single Index under a Corpus.
Parameters |
Name |
Description |
request |
GetIndexRequest
|
responseObserver |
io.grpc.stub.StreamObserver<Index>
|
getIndexEndpoint(GetIndexEndpointRequest request, StreamObserver<IndexEndpoint> responseObserver)
public void getIndexEndpoint(GetIndexEndpointRequest request, StreamObserver<IndexEndpoint> responseObserver)
getSearchConfig(GetSearchConfigRequest request, StreamObserver<SearchConfig> responseObserver)
public void getSearchConfig(GetSearchConfigRequest request, StreamObserver<SearchConfig> responseObserver)
Gets a search configuration inside a corpus.
getSearchHypernym(GetSearchHypernymRequest request, StreamObserver<SearchHypernym> responseObserver)
public void getSearchHypernym(GetSearchHypernymRequest request, StreamObserver<SearchHypernym> responseObserver)
Gets a SearchHypernym inside a corpus.
importAssets(ImportAssetsRequest request, StreamObserver<Operation> responseObserver)
public void importAssets(ImportAssetsRequest request, StreamObserver<Operation> responseObserver)
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, StreamObserver<Operation> responseObserver)
public void indexAsset(IndexAssetRequest request, StreamObserver<Operation> responseObserver)
Index one asset for search.
Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
ingestAsset(StreamObserver<IngestAssetResponse> responseObserver)
public StreamObserver<IngestAssetRequest> ingestAsset(StreamObserver<IngestAssetResponse> responseObserver)
Ingests data for the asset. It is not allowed to ingest a data chunk which
is already expired according to TTL.
This method is only available via the gRPC API (not HTTP since
bi-directional streaming is not supported via HTTP).
listAnnotations(ListAnnotationsRequest request, StreamObserver<ListAnnotationsResponse> responseObserver)
public void listAnnotations(ListAnnotationsRequest request, StreamObserver<ListAnnotationsResponse> responseObserver)
Lists a list of annotations inside asset.
listAssets(ListAssetsRequest request, StreamObserver<ListAssetsResponse> responseObserver)
public void listAssets(ListAssetsRequest request, StreamObserver<ListAssetsResponse> responseObserver)
Lists an list of assets inside corpus.
listCollections(ListCollectionsRequest request, StreamObserver<ListCollectionsResponse> responseObserver)
public void listCollections(ListCollectionsRequest request, StreamObserver<ListCollectionsResponse> responseObserver)
Lists collections inside a corpus.
listCorpora(ListCorporaRequest request, StreamObserver<ListCorporaResponse> responseObserver)
public void listCorpora(ListCorporaRequest request, StreamObserver<ListCorporaResponse> responseObserver)
Lists all corpora in a project.
listDataSchemas(ListDataSchemasRequest request, StreamObserver<ListDataSchemasResponse> responseObserver)
public void listDataSchemas(ListDataSchemasRequest request, StreamObserver<ListDataSchemasResponse> responseObserver)
Lists a list of data schemas inside corpus.
listIndexEndpoints(ListIndexEndpointsRequest request, StreamObserver<ListIndexEndpointsResponse> responseObserver)
public void listIndexEndpoints(ListIndexEndpointsRequest request, StreamObserver<ListIndexEndpointsResponse> responseObserver)
Lists all IndexEndpoints in a project.
listIndexes(ListIndexesRequest request, StreamObserver<ListIndexesResponse> responseObserver)
public void listIndexes(ListIndexesRequest request, StreamObserver<ListIndexesResponse> responseObserver)
List all Indexes in a given Corpus.
listSearchConfigs(ListSearchConfigsRequest request, StreamObserver<ListSearchConfigsResponse> responseObserver)
public void listSearchConfigs(ListSearchConfigsRequest request, StreamObserver<ListSearchConfigsResponse> responseObserver)
Lists all search configurations inside a corpus.
listSearchHypernyms(ListSearchHypernymsRequest request, StreamObserver<ListSearchHypernymsResponse> responseObserver)
public void listSearchHypernyms(ListSearchHypernymsRequest request, StreamObserver<ListSearchHypernymsResponse> responseObserver)
Lists SearchHypernyms inside a corpus.
removeCollectionItem(RemoveCollectionItemRequest request, StreamObserver<RemoveCollectionItemResponse> responseObserver)
public void removeCollectionItem(RemoveCollectionItemRequest request, StreamObserver<RemoveCollectionItemResponse> responseObserver)
Removes an item from a collection.
removeIndexAsset(RemoveIndexAssetRequest request, StreamObserver<Operation> responseObserver)
public void removeIndexAsset(RemoveIndexAssetRequest request, StreamObserver<Operation> responseObserver)
Remove one asset's index data for search.
Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
searchAssets(SearchAssetsRequest request, StreamObserver<SearchAssetsResponse> responseObserver)
public void searchAssets(SearchAssetsRequest request, StreamObserver<SearchAssetsResponse> responseObserver)
searchIndexEndpoint(SearchIndexEndpointRequest request, StreamObserver<SearchIndexEndpointResponse> responseObserver)
public void searchIndexEndpoint(SearchIndexEndpointRequest request, StreamObserver<SearchIndexEndpointResponse> responseObserver)
Search a deployed index endpoint (IMAGE corpus type only).
undeployIndex(UndeployIndexRequest request, StreamObserver<Operation> responseObserver)
public void undeployIndex(UndeployIndexRequest request, StreamObserver<Operation> responseObserver)
Undeploys an Index from IndexEndpoint.
updateAnnotation(UpdateAnnotationRequest request, StreamObserver<Annotation> responseObserver)
public void updateAnnotation(UpdateAnnotationRequest request, StreamObserver<Annotation> responseObserver)
Updates annotation inside asset.
updateAsset(UpdateAssetRequest request, StreamObserver<Asset> responseObserver)
public void updateAsset(UpdateAssetRequest request, StreamObserver<Asset> responseObserver)
Updates an asset inside corpus.
updateCollection(UpdateCollectionRequest request, StreamObserver<Collection> responseObserver)
public void updateCollection(UpdateCollectionRequest request, StreamObserver<Collection> responseObserver)
updateCorpus(UpdateCorpusRequest request, StreamObserver<Corpus> responseObserver)
public void updateCorpus(UpdateCorpusRequest request, StreamObserver<Corpus> responseObserver)
Updates a corpus in a project.
updateDataSchema(UpdateDataSchemaRequest request, StreamObserver<DataSchema> responseObserver)
public void updateDataSchema(UpdateDataSchemaRequest request, StreamObserver<DataSchema> responseObserver)
Updates data schema inside corpus.
updateIndex(UpdateIndexRequest request, StreamObserver<Operation> responseObserver)
public void updateIndex(UpdateIndexRequest request, StreamObserver<Operation> responseObserver)
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, StreamObserver<Operation> responseObserver)
public void updateIndexEndpoint(UpdateIndexEndpointRequest request, StreamObserver<Operation> responseObserver)
Updates an IndexEndpoint.
updateSearchConfig(UpdateSearchConfigRequest request, StreamObserver<SearchConfig> responseObserver)
public void updateSearchConfig(UpdateSearchConfigRequest request, StreamObserver<SearchConfig> responseObserver)
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, StreamObserver<SearchHypernym> responseObserver)
public void updateSearchHypernym(UpdateSearchHypernymRequest request, StreamObserver<SearchHypernym> responseObserver)
Updates a SearchHypernym inside a corpus.
uploadAsset(UploadAssetRequest request, StreamObserver<Operation> responseObserver)
public void uploadAsset(UploadAssetRequest request, StreamObserver<Operation> responseObserver)
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, StreamObserver<ViewCollectionItemsResponse> responseObserver)
public void viewCollectionItems(ViewCollectionItemsRequest request, StreamObserver<ViewCollectionItemsResponse> responseObserver)
View items inside a collection.
viewIndexedAssets(ViewIndexedAssetsRequest request, StreamObserver<ViewIndexedAssetsResponse> responseObserver)
public void viewIndexedAssets(ViewIndexedAssetsRequest request, StreamObserver<ViewIndexedAssetsResponse> responseObserver)
Lists assets inside an index.