Package com.google.cloud.visionai.v1

Class WarehouseGrpc.WarehouseBlockingV2Stub

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

  • Method Details

    • build

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

    • createAsset

      public Asset createAsset(CreateAssetRequest request) throws io.grpc.StatusException
       Creates an asset inside corpus.
      Throws:
      io.grpc.StatusException

    • updateAsset

      public Asset updateAsset(UpdateAssetRequest request) throws io.grpc.StatusException
       Updates an asset inside corpus.
      Throws:
      io.grpc.StatusException

    • getAsset

      public Asset getAsset(GetAssetRequest request) throws io.grpc.StatusException
       Reads an asset inside corpus.
      Throws:
      io.grpc.StatusException

    • listAssets

      public ListAssetsResponse listAssets(ListAssetsRequest request) throws io.grpc.StatusException
       Lists an list of assets inside corpus.
      Throws:
      io.grpc.StatusException

    • deleteAsset

      public Operation deleteAsset(DeleteAssetRequest request) throws io.grpc.StatusException
       Deletes asset inside corpus.
      Throws:
      io.grpc.StatusException

    • uploadAsset

      public Operation uploadAsset(UploadAssetRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • generateRetrievalUrl

      public GenerateRetrievalUrlResponse generateRetrievalUrl(GenerateRetrievalUrlRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • analyzeAsset

      public Operation analyzeAsset(AnalyzeAssetRequest request) throws io.grpc.StatusException
       Analyze asset to power search capability.
      Throws:
      io.grpc.StatusException

    • indexAsset

      public Operation indexAsset(IndexAssetRequest request) throws io.grpc.StatusException
       Index one asset for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
      Throws:
      io.grpc.StatusException

    • removeIndexAsset

      public Operation removeIndexAsset(RemoveIndexAssetRequest request) throws io.grpc.StatusException
       Remove one asset's index data for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
      Throws:
      io.grpc.StatusException

    • viewIndexedAssets

      public ViewIndexedAssetsResponse viewIndexedAssets(ViewIndexedAssetsRequest request) throws io.grpc.StatusException
       Lists assets inside an index.
      Throws:
      io.grpc.StatusException

    • createIndex

      public Operation createIndex(CreateIndexRequest request) throws io.grpc.StatusException
       Creates an Index under the corpus.
      Throws:
      io.grpc.StatusException

    • updateIndex

      public Operation updateIndex(UpdateIndexRequest request) throws io.grpc.StatusException
       Updates an Index under the corpus.
 Users can perform a metadata-only update or trigger a full index rebuild
 with different update_mask values.
      Throws:
      io.grpc.StatusException

    • getIndex

      public Index getIndex(GetIndexRequest request) throws io.grpc.StatusException
       Gets the details of a single Index under a Corpus.
      Throws:
      io.grpc.StatusException

    • listIndexes

      public ListIndexesResponse listIndexes(ListIndexesRequest request) throws io.grpc.StatusException
       List all Indexes in a given Corpus.
      Throws:
      io.grpc.StatusException

    • deleteIndex

      public Operation deleteIndex(DeleteIndexRequest request) throws io.grpc.StatusException
       Delete a single Index. In order to delete an index, the caller must
 make sure that it is not deployed to any index endpoint.
      Throws:
      io.grpc.StatusException

    • createCorpus

      public Operation createCorpus(CreateCorpusRequest request) throws io.grpc.StatusException
       Creates a corpus inside a project.
      Throws:
      io.grpc.StatusException

    • getCorpus

      public Corpus getCorpus(GetCorpusRequest request) throws io.grpc.StatusException
       Gets corpus details inside a project.
      Throws:
      io.grpc.StatusException

    • updateCorpus

      public Corpus updateCorpus(UpdateCorpusRequest request) throws io.grpc.StatusException
       Updates a corpus in a project.
      Throws:
      io.grpc.StatusException

    • listCorpora

      public ListCorporaResponse listCorpora(ListCorporaRequest request) throws io.grpc.StatusException
       Lists all corpora in a project.
      Throws:
      io.grpc.StatusException

    • deleteCorpus

      public com.google.protobuf.Empty deleteCorpus(DeleteCorpusRequest request) throws io.grpc.StatusException
       Deletes a corpus only if its empty.
 Returns empty response.
      Throws:
      io.grpc.StatusException

    • analyzeCorpus

      public Operation analyzeCorpus(AnalyzeCorpusRequest request) throws io.grpc.StatusException
       Analyzes a corpus.
      Throws:
      io.grpc.StatusException

    • createDataSchema

      public DataSchema createDataSchema(CreateDataSchemaRequest request) throws io.grpc.StatusException
       Creates data schema inside corpus.
      Throws:
      io.grpc.StatusException

    • updateDataSchema

      public DataSchema updateDataSchema(UpdateDataSchemaRequest request) throws io.grpc.StatusException
       Updates data schema inside corpus.
      Throws:
      io.grpc.StatusException

    • getDataSchema

      public DataSchema getDataSchema(GetDataSchemaRequest request) throws io.grpc.StatusException
       Gets data schema inside corpus.
      Throws:
      io.grpc.StatusException

    • deleteDataSchema

      public com.google.protobuf.Empty deleteDataSchema(DeleteDataSchemaRequest request) throws io.grpc.StatusException
       Deletes data schema inside corpus.
      Throws:
      io.grpc.StatusException

    • listDataSchemas

      public ListDataSchemasResponse listDataSchemas(ListDataSchemasRequest request) throws io.grpc.StatusException
       Lists a list of data schemas inside corpus.
      Throws:
      io.grpc.StatusException

    • createAnnotation

      public Annotation createAnnotation(CreateAnnotationRequest request) throws io.grpc.StatusException
       Creates annotation inside asset.
      Throws:
      io.grpc.StatusException

    • getAnnotation

      public Annotation getAnnotation(GetAnnotationRequest request) throws io.grpc.StatusException
       Reads annotation inside asset.
      Throws:
      io.grpc.StatusException

    • listAnnotations

      public ListAnnotationsResponse listAnnotations(ListAnnotationsRequest request) throws io.grpc.StatusException
       Lists a list of annotations inside asset.
      Throws:
      io.grpc.StatusException

    • updateAnnotation

      public Annotation updateAnnotation(UpdateAnnotationRequest request) throws io.grpc.StatusException
       Updates annotation inside asset.
      Throws:
      io.grpc.StatusException

    • deleteAnnotation

      public com.google.protobuf.Empty deleteAnnotation(DeleteAnnotationRequest request) throws io.grpc.StatusException
       Deletes annotation inside asset.
      Throws:
      io.grpc.StatusException

    • ingestAsset

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<IngestAssetRequest,IngestAssetResponse> ingestAsset()
       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

      public ClipAssetResponse clipAsset(ClipAssetRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • generateHlsUri

      public GenerateHlsUriResponse generateHlsUri(GenerateHlsUriRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • importAssets

      public Operation importAssets(ImportAssetsRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • createSearchConfig

      public SearchConfig createSearchConfig(CreateSearchConfigRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • updateSearchConfig

      public SearchConfig updateSearchConfig(UpdateSearchConfigRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • getSearchConfig

      public SearchConfig getSearchConfig(GetSearchConfigRequest request) throws io.grpc.StatusException
       Gets a search configuration inside a corpus.
      Throws:
      io.grpc.StatusException

    • deleteSearchConfig

      public com.google.protobuf.Empty deleteSearchConfig(DeleteSearchConfigRequest request) throws io.grpc.StatusException
       Deletes a search configuration inside a corpus.
 For a DeleteSearchConfigRequest to be valid,
 Request.search_configuration.name must already exist.
      Throws:
      io.grpc.StatusException

    • listSearchConfigs

      public ListSearchConfigsResponse listSearchConfigs(ListSearchConfigsRequest request) throws io.grpc.StatusException
       Lists all search configurations inside a corpus.
      Throws:
      io.grpc.StatusException

    • createSearchHypernym

      public SearchHypernym createSearchHypernym(CreateSearchHypernymRequest request) throws io.grpc.StatusException
       Creates a SearchHypernym inside a corpus.
      Throws:
      io.grpc.StatusException

    • updateSearchHypernym

      public SearchHypernym updateSearchHypernym(UpdateSearchHypernymRequest request) throws io.grpc.StatusException
       Updates a SearchHypernym inside a corpus.
      Throws:
      io.grpc.StatusException

    • getSearchHypernym

      public SearchHypernym getSearchHypernym(GetSearchHypernymRequest request) throws io.grpc.StatusException
       Gets a SearchHypernym inside a corpus.
      Throws:
      io.grpc.StatusException

    • deleteSearchHypernym

      public com.google.protobuf.Empty deleteSearchHypernym(DeleteSearchHypernymRequest request) throws io.grpc.StatusException
       Deletes a SearchHypernym inside a corpus.
      Throws:
      io.grpc.StatusException

    • listSearchHypernyms

      public ListSearchHypernymsResponse listSearchHypernyms(ListSearchHypernymsRequest request) throws io.grpc.StatusException
       Lists SearchHypernyms inside a corpus.
      Throws:
      io.grpc.StatusException

    • searchAssets

      public SearchAssetsResponse searchAssets(SearchAssetsRequest request) throws io.grpc.StatusException
       Search media asset.
      Throws:
      io.grpc.StatusException

    • searchIndexEndpoint

      public SearchIndexEndpointResponse searchIndexEndpoint(SearchIndexEndpointRequest request) throws io.grpc.StatusException
       Search a deployed index endpoint (IMAGE corpus type only).
      Throws:
      io.grpc.StatusException

    • createIndexEndpoint

      public Operation createIndexEndpoint(CreateIndexEndpointRequest request) throws io.grpc.StatusException
       Creates an IndexEndpoint.
      Throws:
      io.grpc.StatusException

    • getIndexEndpoint

      public IndexEndpoint getIndexEndpoint(GetIndexEndpointRequest request) throws io.grpc.StatusException
       Gets an IndexEndpoint.
      Throws:
      io.grpc.StatusException

    • listIndexEndpoints

      public ListIndexEndpointsResponse listIndexEndpoints(ListIndexEndpointsRequest request) throws io.grpc.StatusException
       Lists all IndexEndpoints in a project.
      Throws:
      io.grpc.StatusException

    • updateIndexEndpoint

      public Operation updateIndexEndpoint(UpdateIndexEndpointRequest request) throws io.grpc.StatusException
       Updates an IndexEndpoint.
      Throws:
      io.grpc.StatusException

    • deleteIndexEndpoint

      public Operation deleteIndexEndpoint(DeleteIndexEndpointRequest request) throws io.grpc.StatusException
       Deletes an IndexEndpoint.
      Throws:
      io.grpc.StatusException

    • deployIndex

      public Operation deployIndex(DeployIndexRequest request) throws io.grpc.StatusException
       Deploys an Index to IndexEndpoint.
      Throws:
      io.grpc.StatusException

    • undeployIndex

      public Operation undeployIndex(UndeployIndexRequest request) throws io.grpc.StatusException
       Undeploys an Index from IndexEndpoint.
      Throws:
      io.grpc.StatusException

    • createCollection

      public Operation createCollection(CreateCollectionRequest request) throws io.grpc.StatusException
       Creates a collection.
      Throws:
      io.grpc.StatusException

    • deleteCollection

      public Operation deleteCollection(DeleteCollectionRequest request) throws io.grpc.StatusException
       Deletes a collection.
      Throws:
      io.grpc.StatusException

    • getCollection

      public Collection getCollection(GetCollectionRequest request) throws io.grpc.StatusException
       Gets a collection.
      Throws:
      io.grpc.StatusException

    • updateCollection

      public Collection updateCollection(UpdateCollectionRequest request) throws io.grpc.StatusException
       Updates a collection.
      Throws:
      io.grpc.StatusException

    • listCollections

      public ListCollectionsResponse listCollections(ListCollectionsRequest request) throws io.grpc.StatusException
       Lists collections inside a corpus.
      Throws:
      io.grpc.StatusException

    • addCollectionItem

      public AddCollectionItemResponse addCollectionItem(AddCollectionItemRequest request) throws io.grpc.StatusException
       Adds an item into a Collection.
      Throws:
      io.grpc.StatusException

    • removeCollectionItem

      public RemoveCollectionItemResponse removeCollectionItem(RemoveCollectionItemRequest request) throws io.grpc.StatusException
       Removes an item from a collection.
      Throws:
      io.grpc.StatusException

    • viewCollectionItems

      public ViewCollectionItemsResponse viewCollectionItems(ViewCollectionItemsRequest request) throws io.grpc.StatusException
       View items inside a collection.
      Throws:
      io.grpc.StatusException