Package com.google.cloud.visionai.v1

Class WarehouseGrpc.WarehouseFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<WarehouseGrpc.WarehouseFutureStub>
com.google.cloud.visionai.v1.WarehouseGrpc.WarehouseFutureStub
Enclosing class:
WarehouseGrpc
public static final class WarehouseGrpc.WarehouseFutureStub extends io.grpc.stub.AbstractFutureStub<WarehouseGrpc.WarehouseFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service Warehouse. 
 Service that manages media content + metadata for streaming.

  • Method Details

    • build

      protected WarehouseGrpc.WarehouseFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<WarehouseGrpc.WarehouseFutureStub>

    • createAsset

      public com.google.common.util.concurrent.ListenableFuture<Asset> createAsset(CreateAssetRequest request)
       Creates an asset inside corpus.

    • updateAsset

      public com.google.common.util.concurrent.ListenableFuture<Asset> updateAsset(UpdateAssetRequest request)
       Updates an asset inside corpus.

    • getAsset

      public com.google.common.util.concurrent.ListenableFuture<Asset> getAsset(GetAssetRequest request)
       Reads an asset inside corpus.

    • listAssets

      public com.google.common.util.concurrent.ListenableFuture<ListAssetsResponse> listAssets(ListAssetsRequest request)
       Lists an list of assets inside corpus.

    • deleteAsset

      public com.google.common.util.concurrent.ListenableFuture<Operation> deleteAsset(DeleteAssetRequest request)
       Deletes asset inside corpus.

    • uploadAsset

      public com.google.common.util.concurrent.ListenableFuture<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.

    • generateRetrievalUrl

      public com.google.common.util.concurrent.ListenableFuture<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.

    • analyzeAsset

      public com.google.common.util.concurrent.ListenableFuture<Operation> analyzeAsset(AnalyzeAssetRequest request)
       Analyze asset to power search capability.

    • indexAsset

      public com.google.common.util.concurrent.ListenableFuture<Operation> indexAsset(IndexAssetRequest request)
       Index one asset for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND

    • removeIndexAsset

      public com.google.common.util.concurrent.ListenableFuture<Operation> removeIndexAsset(RemoveIndexAssetRequest request)
       Remove one asset's index data for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND

    • viewIndexedAssets

      public com.google.common.util.concurrent.ListenableFuture<ViewIndexedAssetsResponse> viewIndexedAssets(ViewIndexedAssetsRequest request)
       Lists assets inside an index.

    • createIndex

      public com.google.common.util.concurrent.ListenableFuture<Operation> createIndex(CreateIndexRequest request)
       Creates an Index under the corpus.

    • updateIndex

      public com.google.common.util.concurrent.ListenableFuture<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.

    • getIndex

      public com.google.common.util.concurrent.ListenableFuture<Index> getIndex(GetIndexRequest request)
       Gets the details of a single Index under a Corpus.

    • listIndexes

      public com.google.common.util.concurrent.ListenableFuture<ListIndexesResponse> listIndexes(ListIndexesRequest request)
       List all Indexes in a given Corpus.

    • deleteIndex

      public com.google.common.util.concurrent.ListenableFuture<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.

    • createCorpus

      public com.google.common.util.concurrent.ListenableFuture<Operation> createCorpus(CreateCorpusRequest request)
       Creates a corpus inside a project.

    • getCorpus

      public com.google.common.util.concurrent.ListenableFuture<Corpus> getCorpus(GetCorpusRequest request)
       Gets corpus details inside a project.

    • updateCorpus

      public com.google.common.util.concurrent.ListenableFuture<Corpus> updateCorpus(UpdateCorpusRequest request)
       Updates a corpus in a project.

    • listCorpora

      public com.google.common.util.concurrent.ListenableFuture<ListCorporaResponse> listCorpora(ListCorporaRequest request)
       Lists all corpora in a project.

    • deleteCorpus

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteCorpus(DeleteCorpusRequest request)
       Deletes a corpus only if its empty.
 Returns empty response.

    • analyzeCorpus

      public com.google.common.util.concurrent.ListenableFuture<Operation> analyzeCorpus(AnalyzeCorpusRequest request)
       Analyzes a corpus.

    • createDataSchema

      public com.google.common.util.concurrent.ListenableFuture<DataSchema> createDataSchema(CreateDataSchemaRequest request)
       Creates data schema inside corpus.

    • updateDataSchema

      public com.google.common.util.concurrent.ListenableFuture<DataSchema> updateDataSchema(UpdateDataSchemaRequest request)
       Updates data schema inside corpus.

    • getDataSchema

      public com.google.common.util.concurrent.ListenableFuture<DataSchema> getDataSchema(GetDataSchemaRequest request)
       Gets data schema inside corpus.

    • deleteDataSchema

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteDataSchema(DeleteDataSchemaRequest request)
       Deletes data schema inside corpus.

    • listDataSchemas

      public com.google.common.util.concurrent.ListenableFuture<ListDataSchemasResponse> listDataSchemas(ListDataSchemasRequest request)
       Lists a list of data schemas inside corpus.

    • createAnnotation

      public com.google.common.util.concurrent.ListenableFuture<Annotation> createAnnotation(CreateAnnotationRequest request)
       Creates annotation inside asset.

    • getAnnotation

      public com.google.common.util.concurrent.ListenableFuture<Annotation> getAnnotation(GetAnnotationRequest request)
       Reads annotation inside asset.

    • listAnnotations

      public com.google.common.util.concurrent.ListenableFuture<ListAnnotationsResponse> listAnnotations(ListAnnotationsRequest request)
       Lists a list of annotations inside asset.

    • updateAnnotation

      public com.google.common.util.concurrent.ListenableFuture<Annotation> updateAnnotation(UpdateAnnotationRequest request)
       Updates annotation inside asset.

    • deleteAnnotation

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteAnnotation(DeleteAnnotationRequest request)
       Deletes annotation inside asset.

    • clipAsset

      public com.google.common.util.concurrent.ListenableFuture<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.

    • generateHlsUri

      public com.google.common.util.concurrent.ListenableFuture<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.

    • importAssets

      public com.google.common.util.concurrent.ListenableFuture<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.

    • createSearchConfig

      public com.google.common.util.concurrent.ListenableFuture<SearchConfig> createSearchConfig(CreateSearchConfigRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<SearchConfig> updateSearchConfig(UpdateSearchConfigRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<SearchConfig> getSearchConfig(GetSearchConfigRequest request)
       Gets a search configuration inside a corpus.

    • deleteSearchConfig

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteSearchConfig(DeleteSearchConfigRequest request)
       Deletes a search configuration inside a corpus.
 For a DeleteSearchConfigRequest to be valid,
 Request.search_configuration.name must already exist.

    • listSearchConfigs

      public com.google.common.util.concurrent.ListenableFuture<ListSearchConfigsResponse> listSearchConfigs(ListSearchConfigsRequest request)
       Lists all search configurations inside a corpus.

    • createSearchHypernym

      public com.google.common.util.concurrent.ListenableFuture<SearchHypernym> createSearchHypernym(CreateSearchHypernymRequest request)
       Creates a SearchHypernym inside a corpus.

    • updateSearchHypernym

      public com.google.common.util.concurrent.ListenableFuture<SearchHypernym> updateSearchHypernym(UpdateSearchHypernymRequest request)
       Updates a SearchHypernym inside a corpus.

    • getSearchHypernym

      public com.google.common.util.concurrent.ListenableFuture<SearchHypernym> getSearchHypernym(GetSearchHypernymRequest request)
       Gets a SearchHypernym inside a corpus.

    • deleteSearchHypernym

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteSearchHypernym(DeleteSearchHypernymRequest request)
       Deletes a SearchHypernym inside a corpus.

    • listSearchHypernyms

      public com.google.common.util.concurrent.ListenableFuture<ListSearchHypernymsResponse> listSearchHypernyms(ListSearchHypernymsRequest request)
       Lists SearchHypernyms inside a corpus.

    • searchAssets

      public com.google.common.util.concurrent.ListenableFuture<SearchAssetsResponse> searchAssets(SearchAssetsRequest request)
       Search media asset.

    • searchIndexEndpoint

      public com.google.common.util.concurrent.ListenableFuture<SearchIndexEndpointResponse> searchIndexEndpoint(SearchIndexEndpointRequest request)
       Search a deployed index endpoint (IMAGE corpus type only).

    • createIndexEndpoint

      public com.google.common.util.concurrent.ListenableFuture<Operation> createIndexEndpoint(CreateIndexEndpointRequest request)
       Creates an IndexEndpoint.

    • getIndexEndpoint

      public com.google.common.util.concurrent.ListenableFuture<IndexEndpoint> getIndexEndpoint(GetIndexEndpointRequest request)
       Gets an IndexEndpoint.

    • listIndexEndpoints

      public com.google.common.util.concurrent.ListenableFuture<ListIndexEndpointsResponse> listIndexEndpoints(ListIndexEndpointsRequest request)
       Lists all IndexEndpoints in a project.

    • updateIndexEndpoint

      public com.google.common.util.concurrent.ListenableFuture<Operation> updateIndexEndpoint(UpdateIndexEndpointRequest request)
       Updates an IndexEndpoint.

    • deleteIndexEndpoint

      public com.google.common.util.concurrent.ListenableFuture<Operation> deleteIndexEndpoint(DeleteIndexEndpointRequest request)
       Deletes an IndexEndpoint.

    • deployIndex

      public com.google.common.util.concurrent.ListenableFuture<Operation> deployIndex(DeployIndexRequest request)
       Deploys an Index to IndexEndpoint.

    • undeployIndex

      public com.google.common.util.concurrent.ListenableFuture<Operation> undeployIndex(UndeployIndexRequest request)
       Undeploys an Index from IndexEndpoint.

    • createCollection

      public com.google.common.util.concurrent.ListenableFuture<Operation> createCollection(CreateCollectionRequest request)
       Creates a collection.

    • deleteCollection

      public com.google.common.util.concurrent.ListenableFuture<Operation> deleteCollection(DeleteCollectionRequest request)
       Deletes a collection.

    • getCollection

      public com.google.common.util.concurrent.ListenableFuture<Collection> getCollection(GetCollectionRequest request)
       Gets a collection.

    • updateCollection

      public com.google.common.util.concurrent.ListenableFuture<Collection> updateCollection(UpdateCollectionRequest request)
       Updates a collection.

    • listCollections

      public com.google.common.util.concurrent.ListenableFuture<ListCollectionsResponse> listCollections(ListCollectionsRequest request)
       Lists collections inside a corpus.

    • addCollectionItem

      public com.google.common.util.concurrent.ListenableFuture<AddCollectionItemResponse> addCollectionItem(AddCollectionItemRequest request)
       Adds an item into a Collection.

    • removeCollectionItem

      public com.google.common.util.concurrent.ListenableFuture<RemoveCollectionItemResponse> removeCollectionItem(RemoveCollectionItemRequest request)
       Removes an item from a collection.

    • viewCollectionItems

      public com.google.common.util.concurrent.ListenableFuture<ViewCollectionItemsResponse> viewCollectionItems(ViewCollectionItemsRequest request)
       View items inside a collection.