Package com.google.cloud.visionai.v1

Interface WarehouseGrpc.AsyncService

All Known Implementing Classes:
WarehouseGrpc.WarehouseImplBase
Enclosing class:
WarehouseGrpc
public static interface WarehouseGrpc.AsyncService
 Service that manages media content + metadata for streaming.

  • Method Details

    • createAsset

      default void createAsset(CreateAssetRequest request, io.grpc.stub.StreamObserver<Asset> responseObserver)
       Creates an asset inside corpus.

    • updateAsset

      default void updateAsset(UpdateAssetRequest request, io.grpc.stub.StreamObserver<Asset> responseObserver)
       Updates an asset inside corpus.

    • getAsset

      default void getAsset(GetAssetRequest request, io.grpc.stub.StreamObserver<Asset> responseObserver)
       Reads an asset inside corpus.

    • listAssets

      default void listAssets(ListAssetsRequest request, io.grpc.stub.StreamObserver<ListAssetsResponse> responseObserver)
       Lists an list of assets inside corpus.

    • deleteAsset

      default void deleteAsset(DeleteAssetRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Deletes asset inside corpus.

    • uploadAsset

      default void uploadAsset(UploadAssetRequest request, io.grpc.stub.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.

    • generateRetrievalUrl

      default void generateRetrievalUrl(GenerateRetrievalUrlRequest request, io.grpc.stub.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.

    • analyzeAsset

      default void analyzeAsset(AnalyzeAssetRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Analyze asset to power search capability.

    • indexAsset

      default void indexAsset(IndexAssetRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Index one asset for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND

    • removeIndexAsset

      default void removeIndexAsset(RemoveIndexAssetRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Remove one asset's index data for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND

    • viewIndexedAssets

      default void viewIndexedAssets(ViewIndexedAssetsRequest request, io.grpc.stub.StreamObserver<ViewIndexedAssetsResponse> responseObserver)
       Lists assets inside an index.

    • createIndex

      default void createIndex(CreateIndexRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Creates an Index under the corpus.

    • updateIndex

      default void updateIndex(UpdateIndexRequest request, io.grpc.stub.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.

    • getIndex

      default void getIndex(GetIndexRequest request, io.grpc.stub.StreamObserver<Index> responseObserver)
       Gets the details of a single Index under a Corpus.

    • listIndexes

      default void listIndexes(ListIndexesRequest request, io.grpc.stub.StreamObserver<ListIndexesResponse> responseObserver)
       List all Indexes in a given Corpus.

    • deleteIndex

      default void deleteIndex(DeleteIndexRequest request, io.grpc.stub.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.

    • createCorpus

      default void createCorpus(CreateCorpusRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Creates a corpus inside a project.

    • getCorpus

      default void getCorpus(GetCorpusRequest request, io.grpc.stub.StreamObserver<Corpus> responseObserver)
       Gets corpus details inside a project.

    • updateCorpus

      default void updateCorpus(UpdateCorpusRequest request, io.grpc.stub.StreamObserver<Corpus> responseObserver)
       Updates a corpus in a project.

    • listCorpora

      default void listCorpora(ListCorporaRequest request, io.grpc.stub.StreamObserver<ListCorporaResponse> responseObserver)
       Lists all corpora in a project.

    • deleteCorpus

      default void deleteCorpus(DeleteCorpusRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a corpus only if its empty.
 Returns empty response.

    • analyzeCorpus

      default void analyzeCorpus(AnalyzeCorpusRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Analyzes a corpus.

    • createDataSchema

      default void createDataSchema(CreateDataSchemaRequest request, io.grpc.stub.StreamObserver<DataSchema> responseObserver)
       Creates data schema inside corpus.

    • updateDataSchema

      default void updateDataSchema(UpdateDataSchemaRequest request, io.grpc.stub.StreamObserver<DataSchema> responseObserver)
       Updates data schema inside corpus.

    • getDataSchema

      default void getDataSchema(GetDataSchemaRequest request, io.grpc.stub.StreamObserver<DataSchema> responseObserver)
       Gets data schema inside corpus.

    • deleteDataSchema

      default void deleteDataSchema(DeleteDataSchemaRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes data schema inside corpus.

    • listDataSchemas

      default void listDataSchemas(ListDataSchemasRequest request, io.grpc.stub.StreamObserver<ListDataSchemasResponse> responseObserver)
       Lists a list of data schemas inside corpus.

    • createAnnotation

      default void createAnnotation(CreateAnnotationRequest request, io.grpc.stub.StreamObserver<Annotation> responseObserver)
       Creates annotation inside asset.

    • getAnnotation

      default void getAnnotation(GetAnnotationRequest request, io.grpc.stub.StreamObserver<Annotation> responseObserver)
       Reads annotation inside asset.

    • listAnnotations

      default void listAnnotations(ListAnnotationsRequest request, io.grpc.stub.StreamObserver<ListAnnotationsResponse> responseObserver)
       Lists a list of annotations inside asset.

    • updateAnnotation

      default void updateAnnotation(UpdateAnnotationRequest request, io.grpc.stub.StreamObserver<Annotation> responseObserver)
       Updates annotation inside asset.

    • deleteAnnotation

      default void deleteAnnotation(DeleteAnnotationRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes annotation inside asset.

    • ingestAsset

      default io.grpc.stub.StreamObserver<IngestAssetRequest> ingestAsset(io.grpc.stub.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).

    • clipAsset

      default void clipAsset(ClipAssetRequest request, io.grpc.stub.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.

    • generateHlsUri

      default void generateHlsUri(GenerateHlsUriRequest request, io.grpc.stub.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.

    • importAssets

      default void importAssets(ImportAssetsRequest request, io.grpc.stub.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.

    • createSearchConfig

      default void createSearchConfig(CreateSearchConfigRequest request, io.grpc.stub.StreamObserver<SearchConfig> responseObserver)
       Creates a search configuration inside a corpus.
 Please follow the rules below to create a valid CreateSearchConfigRequest.
 --- General Rules ---
 1. Request.search_config_id must not be associated with an existing
    SearchConfig.
 2. Request must contain at least one non-empty search_criteria_property or
    facet_property.
 3. mapped_fields must not be empty, and must map to existing UGA keys.
 4. All mapped_fields must be of the same type.
 5. All mapped_fields must share the same granularity.
 6. All mapped_fields must share the same semantic SearchConfig match
    options.
 For property-specific rules, please reference the comments for
 FacetProperty and SearchCriteriaProperty.

    • updateSearchConfig

      default void updateSearchConfig(UpdateSearchConfigRequest request, io.grpc.stub.StreamObserver<SearchConfig> responseObserver)
       Updates a search configuration inside a corpus.
 Please follow the rules below to create a valid UpdateSearchConfigRequest.
 --- General Rules ---
 1. Request.search_configuration.name must already exist.
 2. Request must contain at least one non-empty search_criteria_property or
 facet_property.
 3. mapped_fields must not be empty, and must map to existing UGA keys.
 4. All mapped_fields must be of the same type.
 5. All mapped_fields must share the same granularity.
 6. All mapped_fields must share the same semantic SearchConfig match
    options.
 For property-specific rules, please reference the comments for
 FacetProperty and SearchCriteriaProperty.

    • getSearchConfig

      default void getSearchConfig(GetSearchConfigRequest request, io.grpc.stub.StreamObserver<SearchConfig> responseObserver)
       Gets a search configuration inside a corpus.

    • deleteSearchConfig

      default void deleteSearchConfig(DeleteSearchConfigRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a search configuration inside a corpus.
 For a DeleteSearchConfigRequest to be valid,
 Request.search_configuration.name must already exist.

    • listSearchConfigs

      default void listSearchConfigs(ListSearchConfigsRequest request, io.grpc.stub.StreamObserver<ListSearchConfigsResponse> responseObserver)
       Lists all search configurations inside a corpus.

    • createSearchHypernym

      default void createSearchHypernym(CreateSearchHypernymRequest request, io.grpc.stub.StreamObserver<SearchHypernym> responseObserver)
       Creates a SearchHypernym inside a corpus.

    • updateSearchHypernym

      default void updateSearchHypernym(UpdateSearchHypernymRequest request, io.grpc.stub.StreamObserver<SearchHypernym> responseObserver)
       Updates a SearchHypernym inside a corpus.

    • getSearchHypernym

      default void getSearchHypernym(GetSearchHypernymRequest request, io.grpc.stub.StreamObserver<SearchHypernym> responseObserver)
       Gets a SearchHypernym inside a corpus.

    • deleteSearchHypernym

      default void deleteSearchHypernym(DeleteSearchHypernymRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a SearchHypernym inside a corpus.

    • listSearchHypernyms

      default void listSearchHypernyms(ListSearchHypernymsRequest request, io.grpc.stub.StreamObserver<ListSearchHypernymsResponse> responseObserver)
       Lists SearchHypernyms inside a corpus.

    • searchAssets

      default void searchAssets(SearchAssetsRequest request, io.grpc.stub.StreamObserver<SearchAssetsResponse> responseObserver)
       Search media asset.

    • searchIndexEndpoint

      default void searchIndexEndpoint(SearchIndexEndpointRequest request, io.grpc.stub.StreamObserver<SearchIndexEndpointResponse> responseObserver)
       Search a deployed index endpoint (IMAGE corpus type only).

    • createIndexEndpoint

      default void createIndexEndpoint(CreateIndexEndpointRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Creates an IndexEndpoint.

    • getIndexEndpoint

      default void getIndexEndpoint(GetIndexEndpointRequest request, io.grpc.stub.StreamObserver<IndexEndpoint> responseObserver)
       Gets an IndexEndpoint.

    • listIndexEndpoints

      default void listIndexEndpoints(ListIndexEndpointsRequest request, io.grpc.stub.StreamObserver<ListIndexEndpointsResponse> responseObserver)
       Lists all IndexEndpoints in a project.

    • updateIndexEndpoint

      default void updateIndexEndpoint(UpdateIndexEndpointRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Updates an IndexEndpoint.

    • deleteIndexEndpoint

      default void deleteIndexEndpoint(DeleteIndexEndpointRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Deletes an IndexEndpoint.

    • deployIndex

      default void deployIndex(DeployIndexRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Deploys an Index to IndexEndpoint.

    • undeployIndex

      default void undeployIndex(UndeployIndexRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Undeploys an Index from IndexEndpoint.

    • createCollection

      default void createCollection(CreateCollectionRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Creates a collection.

    • deleteCollection

      default void deleteCollection(DeleteCollectionRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Deletes a collection.

    • getCollection

      default void getCollection(GetCollectionRequest request, io.grpc.stub.StreamObserver<Collection> responseObserver)
       Gets a collection.

    • updateCollection

      default void updateCollection(UpdateCollectionRequest request, io.grpc.stub.StreamObserver<Collection> responseObserver)
       Updates a collection.

    • listCollections

      default void listCollections(ListCollectionsRequest request, io.grpc.stub.StreamObserver<ListCollectionsResponse> responseObserver)
       Lists collections inside a corpus.

    • addCollectionItem

      default void addCollectionItem(AddCollectionItemRequest request, io.grpc.stub.StreamObserver<AddCollectionItemResponse> responseObserver)
       Adds an item into a Collection.

    • removeCollectionItem

      default void removeCollectionItem(RemoveCollectionItemRequest request, io.grpc.stub.StreamObserver<RemoveCollectionItemResponse> responseObserver)
       Removes an item from a collection.

    • viewCollectionItems

      default void viewCollectionItems(ViewCollectionItemsRequest request, io.grpc.stub.StreamObserver<ViewCollectionItemsResponse> responseObserver)
       View items inside a collection.