Package com.google.cloud.visionai.v1

Class WarehouseGrpc.WarehouseBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<WarehouseGrpc.WarehouseBlockingStub>

com.google.cloud.visionai.v1.WarehouseGrpc.WarehouseBlockingStub

Enclosing class:

WarehouseGrpc

public static final class WarehouseGrpc.WarehouseBlockingStub
extends io.grpc.stub.AbstractBlockingStub<WarehouseGrpc.WarehouseBlockingStub>

A stub to allow clients to do limited synchronous rpc calls to service Warehouse.

 Service that manages media content + metadata for streaming.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
AddCollectionItemResponse	addCollectionItem(AddCollectionItemRequest request)	Adds an item into a Collection.
Operation	analyzeAsset(AnalyzeAssetRequest request)	Analyze asset to power search capability.
Operation	analyzeCorpus(AnalyzeCorpusRequest request)	Analyzes a corpus.
protected WarehouseGrpc.WarehouseBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
ClipAssetResponse	clipAsset(ClipAssetRequest request)	Supported by STREAM_VIDEO corpus type.
Annotation	createAnnotation(CreateAnnotationRequest request)	Creates annotation inside asset.
Asset	createAsset(CreateAssetRequest request)	Creates an asset inside corpus.
Operation	createCollection(CreateCollectionRequest request)	Creates a collection.
Operation	createCorpus(CreateCorpusRequest request)	Creates a corpus inside a project.
DataSchema	createDataSchema(CreateDataSchemaRequest request)	Creates data schema inside corpus.
Operation	createIndex(CreateIndexRequest request)	Creates an Index under the corpus.
Operation	createIndexEndpoint(CreateIndexEndpointRequest request)	Creates an IndexEndpoint.
SearchConfig	createSearchConfig(CreateSearchConfigRequest request)	Creates a search configuration inside a corpus.
SearchHypernym	createSearchHypernym(CreateSearchHypernymRequest request)	Creates a SearchHypernym inside a corpus.
com.google.protobuf.Empty	deleteAnnotation(DeleteAnnotationRequest request)	Deletes annotation inside asset.
Operation	deleteAsset(DeleteAssetRequest request)	Deletes asset inside corpus.
Operation	deleteCollection(DeleteCollectionRequest request)	Deletes a collection.
com.google.protobuf.Empty	deleteCorpus(DeleteCorpusRequest request)	Deletes a corpus only if its empty.
com.google.protobuf.Empty	deleteDataSchema(DeleteDataSchemaRequest request)	Deletes data schema inside corpus.
Operation	deleteIndex(DeleteIndexRequest request)	Delete a single Index.
Operation	deleteIndexEndpoint(DeleteIndexEndpointRequest request)	Deletes an IndexEndpoint.
com.google.protobuf.Empty	deleteSearchConfig(DeleteSearchConfigRequest request)	Deletes a search configuration inside a corpus.
com.google.protobuf.Empty	deleteSearchHypernym(DeleteSearchHypernymRequest request)	Deletes a SearchHypernym inside a corpus.
Operation	deployIndex(DeployIndexRequest request)	Deploys an Index to IndexEndpoint.
GenerateHlsUriResponse	generateHlsUri(GenerateHlsUriRequest request)	Generates a uri for an HLS manifest.
GenerateRetrievalUrlResponse	generateRetrievalUrl(GenerateRetrievalUrlRequest request)	Generates a signed url for downloading the asset.
Annotation	getAnnotation(GetAnnotationRequest request)	Reads annotation inside asset.
Asset	getAsset(GetAssetRequest request)	Reads an asset inside corpus.
Collection	getCollection(GetCollectionRequest request)	Gets a collection.
Corpus	getCorpus(GetCorpusRequest request)	Gets corpus details inside a project.
DataSchema	getDataSchema(GetDataSchemaRequest request)	Gets data schema inside corpus.
Index	getIndex(GetIndexRequest request)	Gets the details of a single Index under a Corpus.
IndexEndpoint	getIndexEndpoint(GetIndexEndpointRequest request)	Gets an IndexEndpoint.
SearchConfig	getSearchConfig(GetSearchConfigRequest request)	Gets a search configuration inside a corpus.
SearchHypernym	getSearchHypernym(GetSearchHypernymRequest request)	Gets a SearchHypernym inside a corpus.
Operation	importAssets(ImportAssetsRequest request)	Imports assets (images plus annotations) from a meta file on cloud storage.
Operation	indexAsset(IndexAssetRequest request)	Index one asset for search.
ListAnnotationsResponse	listAnnotations(ListAnnotationsRequest request)	Lists a list of annotations inside asset.
ListAssetsResponse	listAssets(ListAssetsRequest request)	Lists an list of assets inside corpus.
ListCollectionsResponse	listCollections(ListCollectionsRequest request)	Lists collections inside a corpus.
ListCorporaResponse	listCorpora(ListCorporaRequest request)	Lists all corpora in a project.
ListDataSchemasResponse	listDataSchemas(ListDataSchemasRequest request)	Lists a list of data schemas inside corpus.
ListIndexEndpointsResponse	listIndexEndpoints(ListIndexEndpointsRequest request)	Lists all IndexEndpoints in a project.
ListIndexesResponse	listIndexes(ListIndexesRequest request)	List all Indexes in a given Corpus.
ListSearchConfigsResponse	listSearchConfigs(ListSearchConfigsRequest request)	Lists all search configurations inside a corpus.
ListSearchHypernymsResponse	listSearchHypernyms(ListSearchHypernymsRequest request)	Lists SearchHypernyms inside a corpus.
RemoveCollectionItemResponse	removeCollectionItem(RemoveCollectionItemRequest request)	Removes an item from a collection.
Operation	removeIndexAsset(RemoveIndexAssetRequest request)	Remove one asset's index data for search.
SearchAssetsResponse	searchAssets(SearchAssetsRequest request)	Search media asset.
SearchIndexEndpointResponse	searchIndexEndpoint(SearchIndexEndpointRequest request)	Search a deployed index endpoint (IMAGE corpus type only).
Operation	undeployIndex(UndeployIndexRequest request)	Undeploys an Index from IndexEndpoint.
Annotation	updateAnnotation(UpdateAnnotationRequest request)	Updates annotation inside asset.
Asset	updateAsset(UpdateAssetRequest request)	Updates an asset inside corpus.
Collection	updateCollection(UpdateCollectionRequest request)	Updates a collection.
Corpus	updateCorpus(UpdateCorpusRequest request)	Updates a corpus in a project.
DataSchema	updateDataSchema(UpdateDataSchemaRequest request)	Updates data schema inside corpus.
Operation	updateIndex(UpdateIndexRequest request)	Updates an Index under the corpus.
Operation	updateIndexEndpoint(UpdateIndexEndpointRequest request)	Updates an IndexEndpoint.
SearchConfig	updateSearchConfig(UpdateSearchConfigRequest request)	Updates a search configuration inside a corpus.
SearchHypernym	updateSearchHypernym(UpdateSearchHypernymRequest request)	Updates a SearchHypernym inside a corpus.
Operation	uploadAsset(UploadAssetRequest request)	Upload asset by specifing the asset Cloud Storage uri.
ViewCollectionItemsResponse	viewCollectionItems(ViewCollectionItemsRequest request)	View items inside a collection.
ViewIndexedAssetsResponse	viewIndexedAssets(ViewIndexedAssetsRequest request)	Lists assets inside an index.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected WarehouseGrpc.WarehouseBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<WarehouseGrpc.WarehouseBlockingStub>

createAsset

public Asset createAsset(CreateAssetRequest request)

 Creates an asset inside corpus.
 

updateAsset

public Asset updateAsset(UpdateAssetRequest request)

 Updates an asset inside corpus.
 

getAsset

public Asset getAsset(GetAssetRequest request)

 Reads an asset inside corpus.
 

listAssets

public ListAssetsResponse listAssets(ListAssetsRequest request)

 Lists an list of assets inside corpus.
 

deleteAsset

public Operation deleteAsset(DeleteAssetRequest request)

 Deletes asset inside corpus.
 

uploadAsset

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.
 

generateRetrievalUrl

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.
 

analyzeAsset

public Operation analyzeAsset(AnalyzeAssetRequest request)

 Analyze asset to power search capability.
 

indexAsset

public Operation indexAsset(IndexAssetRequest request)

 Index one asset for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
 

removeIndexAsset

public Operation removeIndexAsset(RemoveIndexAssetRequest request)

 Remove one asset's index data for search.
 Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
 

viewIndexedAssets

public ViewIndexedAssetsResponse viewIndexedAssets(ViewIndexedAssetsRequest request)

 Lists assets inside an index.
 

createIndex

public Operation createIndex(CreateIndexRequest request)

 Creates an Index under the corpus.
 

updateIndex

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.
 

getIndex

public Index getIndex(GetIndexRequest request)

 Gets the details of a single Index under a Corpus.
 

listIndexes

public ListIndexesResponse listIndexes(ListIndexesRequest request)

 List all Indexes in a given Corpus.
 

deleteIndex

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.
 

createCorpus

public Operation createCorpus(CreateCorpusRequest request)

 Creates a corpus inside a project.
 

getCorpus

public Corpus getCorpus(GetCorpusRequest request)

 Gets corpus details inside a project.
 

updateCorpus

public Corpus updateCorpus(UpdateCorpusRequest request)

 Updates a corpus in a project.
 

listCorpora

public ListCorporaResponse listCorpora(ListCorporaRequest request)

 Lists all corpora in a project.
 

deleteCorpus

public com.google.protobuf.Empty deleteCorpus(DeleteCorpusRequest request)

 Deletes a corpus only if its empty.
 Returns empty response.
 

analyzeCorpus

public Operation analyzeCorpus(AnalyzeCorpusRequest request)

 Analyzes a corpus.
 

createDataSchema

public DataSchema createDataSchema(CreateDataSchemaRequest request)

 Creates data schema inside corpus.
 

updateDataSchema

public DataSchema updateDataSchema(UpdateDataSchemaRequest request)

 Updates data schema inside corpus.
 

getDataSchema

public DataSchema getDataSchema(GetDataSchemaRequest request)

 Gets data schema inside corpus.
 

deleteDataSchema

public com.google.protobuf.Empty deleteDataSchema(DeleteDataSchemaRequest request)

 Deletes data schema inside corpus.
 

listDataSchemas

public ListDataSchemasResponse listDataSchemas(ListDataSchemasRequest request)

 Lists a list of data schemas inside corpus.
 

createAnnotation

public Annotation createAnnotation(CreateAnnotationRequest request)

 Creates annotation inside asset.
 

getAnnotation

public Annotation getAnnotation(GetAnnotationRequest request)

 Reads annotation inside asset.
 

listAnnotations

public ListAnnotationsResponse listAnnotations(ListAnnotationsRequest request)

 Lists a list of annotations inside asset.
 

updateAnnotation

public Annotation updateAnnotation(UpdateAnnotationRequest request)

 Updates annotation inside asset.
 

deleteAnnotation

public com.google.protobuf.Empty deleteAnnotation(DeleteAnnotationRequest request)

 Deletes annotation inside asset.
 

clipAsset

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.
 

generateHlsUri

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.
 

importAssets

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.
 

createSearchConfig

public 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 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 SearchConfig getSearchConfig(GetSearchConfigRequest request)

 Gets a search configuration inside a corpus.
 

deleteSearchConfig

public 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 ListSearchConfigsResponse listSearchConfigs(ListSearchConfigsRequest request)

 Lists all search configurations inside a corpus.
 

createSearchHypernym

public SearchHypernym createSearchHypernym(CreateSearchHypernymRequest request)

 Creates a SearchHypernym inside a corpus.
 

updateSearchHypernym

public SearchHypernym updateSearchHypernym(UpdateSearchHypernymRequest request)

 Updates a SearchHypernym inside a corpus.
 

getSearchHypernym

public SearchHypernym getSearchHypernym(GetSearchHypernymRequest request)

 Gets a SearchHypernym inside a corpus.
 

deleteSearchHypernym

public com.google.protobuf.Empty deleteSearchHypernym(DeleteSearchHypernymRequest request)

 Deletes a SearchHypernym inside a corpus.
 

listSearchHypernyms

public ListSearchHypernymsResponse listSearchHypernyms(ListSearchHypernymsRequest request)

 Lists SearchHypernyms inside a corpus.
 

searchAssets

public SearchAssetsResponse searchAssets(SearchAssetsRequest request)

 Search media asset.
 

searchIndexEndpoint

public SearchIndexEndpointResponse searchIndexEndpoint(SearchIndexEndpointRequest request)

 Search a deployed index endpoint (IMAGE corpus type only).
 

createIndexEndpoint

public Operation createIndexEndpoint(CreateIndexEndpointRequest request)

 Creates an IndexEndpoint.
 

getIndexEndpoint

public IndexEndpoint getIndexEndpoint(GetIndexEndpointRequest request)

 Gets an IndexEndpoint.
 

listIndexEndpoints

public ListIndexEndpointsResponse listIndexEndpoints(ListIndexEndpointsRequest request)

 Lists all IndexEndpoints in a project.
 

updateIndexEndpoint

public Operation updateIndexEndpoint(UpdateIndexEndpointRequest request)

 Updates an IndexEndpoint.
 

deleteIndexEndpoint

public Operation deleteIndexEndpoint(DeleteIndexEndpointRequest request)

 Deletes an IndexEndpoint.
 

deployIndex

public Operation deployIndex(DeployIndexRequest request)

 Deploys an Index to IndexEndpoint.
 

undeployIndex

public Operation undeployIndex(UndeployIndexRequest request)

 Undeploys an Index from IndexEndpoint.
 

createCollection

public Operation createCollection(CreateCollectionRequest request)

 Creates a collection.
 

deleteCollection

public Operation deleteCollection(DeleteCollectionRequest request)

 Deletes a collection.
 

getCollection

public Collection getCollection(GetCollectionRequest request)

 Gets a collection.
 

updateCollection

public Collection updateCollection(UpdateCollectionRequest request)

 Updates a collection.
 

listCollections

public ListCollectionsResponse listCollections(ListCollectionsRequest request)

 Lists collections inside a corpus.
 

addCollectionItem

public AddCollectionItemResponse addCollectionItem(AddCollectionItemRequest request)

 Adds an item into a Collection.
 

removeCollectionItem

public RemoveCollectionItemResponse removeCollectionItem(RemoveCollectionItemRequest request)

 Removes an item from a collection.
 

viewCollectionItems

public ViewCollectionItemsResponse viewCollectionItems(ViewCollectionItemsRequest request)

 View items inside a collection.