Vision AI v1 API - Class WarehouseClientImpl (1.0.0-beta01) 

public sealed class WarehouseClientImpl : WarehouseClient

Reference documentation and code samples for the Vision AI v1 API class WarehouseClientImpl.

Warehouse client wrapper implementation, for convenient use.

Inheritance

object > WarehouseClient > WarehouseClientImpl

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Remarks

Service that manages media content + metadata for streaming.

Constructors

WarehouseClientImpl(WarehouseClient, WarehouseSettings, ILogger)

public WarehouseClientImpl(Warehouse.WarehouseClient grpcClient, WarehouseSettings settings, ILogger logger)

Constructs a client wrapper for the Warehouse service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient WarehouseWarehouseClient

The underlying gRPC client.
settings WarehouseSettings

The base WarehouseSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

AnalyzeAssetOperationsClient

public override OperationsClient AnalyzeAssetOperationsClient { get; }

The long-running operations client for AnalyzeAsset.

Property Value
Type Description
OperationsClient
Overrides

AnalyzeCorpusOperationsClient

public override OperationsClient AnalyzeCorpusOperationsClient { get; }

The long-running operations client for AnalyzeCorpus.

Property Value
Type Description
OperationsClient
Overrides

CreateCollectionOperationsClient

public override OperationsClient CreateCollectionOperationsClient { get; }

The long-running operations client for CreateCollection.

Property Value
Type Description
OperationsClient
Overrides

CreateCorpusOperationsClient

public override OperationsClient CreateCorpusOperationsClient { get; }

The long-running operations client for CreateCorpus.

Property Value
Type Description
OperationsClient
Overrides

CreateIndexEndpointOperationsClient

public override OperationsClient CreateIndexEndpointOperationsClient { get; }

The long-running operations client for CreateIndexEndpoint.

Property Value
Type Description
OperationsClient
Overrides

CreateIndexOperationsClient

public override OperationsClient CreateIndexOperationsClient { get; }

The long-running operations client for CreateIndex.

Property Value
Type Description
OperationsClient
Overrides

DeleteAssetOperationsClient

public override OperationsClient DeleteAssetOperationsClient { get; }

The long-running operations client for DeleteAsset.

Property Value
Type Description
OperationsClient
Overrides

DeleteCollectionOperationsClient

public override OperationsClient DeleteCollectionOperationsClient { get; }

The long-running operations client for DeleteCollection.

Property Value
Type Description
OperationsClient
Overrides

DeleteIndexEndpointOperationsClient

public override OperationsClient DeleteIndexEndpointOperationsClient { get; }

The long-running operations client for DeleteIndexEndpoint.

Property Value
Type Description
OperationsClient
Overrides

DeleteIndexOperationsClient

public override OperationsClient DeleteIndexOperationsClient { get; }

The long-running operations client for DeleteIndex.

Property Value
Type Description
OperationsClient
Overrides

DeployIndexOperationsClient

public override OperationsClient DeployIndexOperationsClient { get; }

The long-running operations client for DeployIndex.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Warehouse.WarehouseClient GrpcClient { get; }

The underlying gRPC Warehouse client

Property Value
Type Description
WarehouseWarehouseClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

ImportAssetsOperationsClient

public override OperationsClient ImportAssetsOperationsClient { get; }

The long-running operations client for ImportAssets.

Property Value
Type Description
OperationsClient
Overrides

IndexAssetOperationsClient

public override OperationsClient IndexAssetOperationsClient { get; }

The long-running operations client for IndexAsset.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RemoveIndexAssetOperationsClient

public override OperationsClient RemoveIndexAssetOperationsClient { get; }

The long-running operations client for RemoveIndexAsset.

Property Value
Type Description
OperationsClient
Overrides

UndeployIndexOperationsClient

public override OperationsClient UndeployIndexOperationsClient { get; }

The long-running operations client for UndeployIndex.

Property Value
Type Description
OperationsClient
Overrides

UpdateIndexEndpointOperationsClient

public override OperationsClient UpdateIndexEndpointOperationsClient { get; }

The long-running operations client for UpdateIndexEndpoint.

Property Value
Type Description
OperationsClient
Overrides

UpdateIndexOperationsClient

public override OperationsClient UpdateIndexOperationsClient { get; }

The long-running operations client for UpdateIndex.

Property Value
Type Description
OperationsClient
Overrides

UploadAssetOperationsClient

public override OperationsClient UploadAssetOperationsClient { get; }

The long-running operations client for UploadAsset.

Property Value
Type Description
OperationsClient
Overrides

Methods

AddCollectionItem(AddCollectionItemRequest, CallSettings)

public override AddCollectionItemResponse AddCollectionItem(AddCollectionItemRequest request, CallSettings callSettings = null)

Adds an item into a Collection.

Parameters
Name Description
request AddCollectionItemRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AddCollectionItemResponse

The RPC response.
Overrides

AddCollectionItemAsync(AddCollectionItemRequest, CallSettings)

public override Task<AddCollectionItemResponse> AddCollectionItemAsync(AddCollectionItemRequest request, CallSettings callSettings = null)

Adds an item into a Collection.

Parameters
Name Description
request AddCollectionItemRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAddCollectionItemResponse

A Task containing the RPC response.
Overrides

AnalyzeAsset(AnalyzeAssetRequest, CallSettings)

public override Operation<AnalyzeAssetResponse, AnalyzeAssetMetadata> AnalyzeAsset(AnalyzeAssetRequest request, CallSettings callSettings = null)

Analyze asset to power search capability.

Parameters
Name Description
request AnalyzeAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAnalyzeAssetResponseAnalyzeAssetMetadata

The RPC response.
Overrides

AnalyzeAssetAsync(AnalyzeAssetRequest, CallSettings)

public override Task<Operation<AnalyzeAssetResponse, AnalyzeAssetMetadata>> AnalyzeAssetAsync(AnalyzeAssetRequest request, CallSettings callSettings = null)

Analyze asset to power search capability.

Parameters
Name Description
request AnalyzeAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAnalyzeAssetResponseAnalyzeAssetMetadata

A Task containing the RPC response.
Overrides

AnalyzeCorpus(AnalyzeCorpusRequest, CallSettings)

public override Operation<AnalyzeCorpusResponse, AnalyzeCorpusMetadata> AnalyzeCorpus(AnalyzeCorpusRequest request, CallSettings callSettings = null)

Analyzes a corpus.

Parameters
Name Description
request AnalyzeCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAnalyzeCorpusResponseAnalyzeCorpusMetadata

The RPC response.
Overrides

AnalyzeCorpusAsync(AnalyzeCorpusRequest, CallSettings)

public override Task<Operation<AnalyzeCorpusResponse, AnalyzeCorpusMetadata>> AnalyzeCorpusAsync(AnalyzeCorpusRequest request, CallSettings callSettings = null)

Analyzes a corpus.

Parameters
Name Description
request AnalyzeCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAnalyzeCorpusResponseAnalyzeCorpusMetadata

A Task containing the RPC response.
Overrides

ClipAsset(ClipAssetRequest, CallSettings)

public override ClipAssetResponse ClipAsset(ClipAssetRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ClipAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ClipAssetResponse

The RPC response.
Overrides

ClipAssetAsync(ClipAssetRequest, CallSettings)

public override Task<ClipAssetResponse> ClipAssetAsync(ClipAssetRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ClipAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskClipAssetResponse

A Task containing the RPC response.
Overrides

CreateAnnotation(CreateAnnotationRequest, CallSettings)

public override Annotation CreateAnnotation(CreateAnnotationRequest request, CallSettings callSettings = null)

Creates annotation inside asset.

Parameters
Name Description
request CreateAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Annotation

The RPC response.
Overrides

CreateAnnotationAsync(CreateAnnotationRequest, CallSettings)

public override Task<Annotation> CreateAnnotationAsync(CreateAnnotationRequest request, CallSettings callSettings = null)

Creates annotation inside asset.

Parameters
Name Description
request CreateAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAnnotation

A Task containing the RPC response.
Overrides

CreateAsset(CreateAssetRequest, CallSettings)

public override Asset CreateAsset(CreateAssetRequest request, CallSettings callSettings = null)

Creates an asset inside corpus.

Parameters
Name Description
request CreateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Asset

The RPC response.
Overrides

CreateAssetAsync(CreateAssetRequest, CallSettings)

public override Task<Asset> CreateAssetAsync(CreateAssetRequest request, CallSettings callSettings = null)

Creates an asset inside corpus.

Parameters
Name Description
request CreateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAsset

A Task containing the RPC response.
Overrides

CreateCollection(CreateCollectionRequest, CallSettings)

public override Operation<Collection, CreateCollectionMetadata> CreateCollection(CreateCollectionRequest request, CallSettings callSettings = null)

Creates a collection.

Parameters
Name Description
request CreateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationCollectionCreateCollectionMetadata

The RPC response.
Overrides

CreateCollectionAsync(CreateCollectionRequest, CallSettings)

public override Task<Operation<Collection, CreateCollectionMetadata>> CreateCollectionAsync(CreateCollectionRequest request, CallSettings callSettings = null)

Creates a collection.

Parameters
Name Description
request CreateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationCollectionCreateCollectionMetadata

A Task containing the RPC response.
Overrides

CreateCorpus(CreateCorpusRequest, CallSettings)

public override Operation<Corpus, CreateCorpusMetadata> CreateCorpus(CreateCorpusRequest request, CallSettings callSettings = null)

Creates a corpus inside a project.

Parameters
Name Description
request CreateCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationCorpusCreateCorpusMetadata

The RPC response.
Overrides

CreateCorpusAsync(CreateCorpusRequest, CallSettings)

public override Task<Operation<Corpus, CreateCorpusMetadata>> CreateCorpusAsync(CreateCorpusRequest request, CallSettings callSettings = null)

Creates a corpus inside a project.

Parameters
Name Description
request CreateCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationCorpusCreateCorpusMetadata

A Task containing the RPC response.
Overrides

CreateDataSchema(CreateDataSchemaRequest, CallSettings)

public override DataSchema CreateDataSchema(CreateDataSchemaRequest request, CallSettings callSettings = null)

Creates data schema inside corpus.

Parameters
Name Description
request CreateDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataSchema

The RPC response.
Overrides

CreateDataSchemaAsync(CreateDataSchemaRequest, CallSettings)

public override Task<DataSchema> CreateDataSchemaAsync(CreateDataSchemaRequest request, CallSettings callSettings = null)

Creates data schema inside corpus.

Parameters
Name Description
request CreateDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataSchema

A Task containing the RPC response.
Overrides

CreateIndex(CreateIndexRequest, CallSettings)

public override Operation<Index, CreateIndexMetadata> CreateIndex(CreateIndexRequest request, CallSettings callSettings = null)

Creates an Index under the corpus.

Parameters
Name Description
request CreateIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexCreateIndexMetadata

The RPC response.
Overrides

CreateIndexAsync(CreateIndexRequest, CallSettings)

public override Task<Operation<Index, CreateIndexMetadata>> CreateIndexAsync(CreateIndexRequest request, CallSettings callSettings = null)

Creates an Index under the corpus.

Parameters
Name Description
request CreateIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexCreateIndexMetadata

A Task containing the RPC response.
Overrides

CreateIndexEndpoint(CreateIndexEndpointRequest, CallSettings)

public override Operation<IndexEndpoint, CreateIndexEndpointMetadata> CreateIndexEndpoint(CreateIndexEndpointRequest request, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name Description
request CreateIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexEndpointCreateIndexEndpointMetadata

The RPC response.
Overrides

CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallSettings)

public override Task<Operation<IndexEndpoint, CreateIndexEndpointMetadata>> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name Description
request CreateIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexEndpointCreateIndexEndpointMetadata

A Task containing the RPC response.
Overrides

CreateSearchConfig(CreateSearchConfigRequest, CallSettings)

public override SearchConfig CreateSearchConfig(CreateSearchConfigRequest request, CallSettings callSettings = null)

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.
Parameters
Name Description
request CreateSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SearchConfig

The RPC response.
Overrides

CreateSearchConfigAsync(CreateSearchConfigRequest, CallSettings)

public override Task<SearchConfig> CreateSearchConfigAsync(CreateSearchConfigRequest request, CallSettings callSettings = null)

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.
Parameters
Name Description
request CreateSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSearchConfig

A Task containing the RPC response.
Overrides

CreateSearchHypernym(CreateSearchHypernymRequest, CallSettings)

public override SearchHypernym CreateSearchHypernym(CreateSearchHypernymRequest request, CallSettings callSettings = null)

Creates a SearchHypernym inside a corpus.

Parameters
Name Description
request CreateSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SearchHypernym

The RPC response.
Overrides

CreateSearchHypernymAsync(CreateSearchHypernymRequest, CallSettings)

public override Task<SearchHypernym> CreateSearchHypernymAsync(CreateSearchHypernymRequest request, CallSettings callSettings = null)

Creates a SearchHypernym inside a corpus.

Parameters
Name Description
request CreateSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSearchHypernym

A Task containing the RPC response.
Overrides

DeleteAnnotation(DeleteAnnotationRequest, CallSettings)

public override void DeleteAnnotation(DeleteAnnotationRequest request, CallSettings callSettings = null)

Deletes annotation inside asset.

Parameters
Name Description
request DeleteAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteAnnotationAsync(DeleteAnnotationRequest, CallSettings)

public override Task DeleteAnnotationAsync(DeleteAnnotationRequest request, CallSettings callSettings = null)

Deletes annotation inside asset.

Parameters
Name Description
request DeleteAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteAsset(DeleteAssetRequest, CallSettings)

public override Operation<Empty, DeleteAssetMetadata> DeleteAsset(DeleteAssetRequest request, CallSettings callSettings = null)

Deletes asset inside corpus.

Parameters
Name Description
request DeleteAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteAssetMetadata

The RPC response.
Overrides

DeleteAssetAsync(DeleteAssetRequest, CallSettings)

public override Task<Operation<Empty, DeleteAssetMetadata>> DeleteAssetAsync(DeleteAssetRequest request, CallSettings callSettings = null)

Deletes asset inside corpus.

Parameters
Name Description
request DeleteAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteAssetMetadata

A Task containing the RPC response.
Overrides

DeleteCollection(DeleteCollectionRequest, CallSettings)

public override Operation<Empty, DeleteCollectionMetadata> DeleteCollection(DeleteCollectionRequest request, CallSettings callSettings = null)

Deletes a collection.

Parameters
Name Description
request DeleteCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteCollectionMetadata

The RPC response.
Overrides

DeleteCollectionAsync(DeleteCollectionRequest, CallSettings)

public override Task<Operation<Empty, DeleteCollectionMetadata>> DeleteCollectionAsync(DeleteCollectionRequest request, CallSettings callSettings = null)

Deletes a collection.

Parameters
Name Description
request DeleteCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteCollectionMetadata

A Task containing the RPC response.
Overrides

DeleteCorpus(DeleteCorpusRequest, CallSettings)

public override void DeleteCorpus(DeleteCorpusRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteCorpusAsync(DeleteCorpusRequest, CallSettings)

public override Task DeleteCorpusAsync(DeleteCorpusRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteDataSchema(DeleteDataSchemaRequest, CallSettings)

public override void DeleteDataSchema(DeleteDataSchemaRequest request, CallSettings callSettings = null)

Deletes data schema inside corpus.

Parameters
Name Description
request DeleteDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteDataSchemaAsync(DeleteDataSchemaRequest, CallSettings)

public override Task DeleteDataSchemaAsync(DeleteDataSchemaRequest request, CallSettings callSettings = null)

Deletes data schema inside corpus.

Parameters
Name Description
request DeleteDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteIndex(DeleteIndexRequest, CallSettings)

public override Operation<Empty, DeleteIndexMetadata> DeleteIndex(DeleteIndexRequest request, CallSettings callSettings = null)

Delete a single Index. In order to delete an index, the caller must make sure that it is not deployed to any index endpoint.

Parameters
Name Description
request DeleteIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteIndexMetadata

The RPC response.
Overrides

DeleteIndexAsync(DeleteIndexRequest, CallSettings)

public override Task<Operation<Empty, DeleteIndexMetadata>> DeleteIndexAsync(DeleteIndexRequest request, CallSettings callSettings = null)

Delete a single Index. In order to delete an index, the caller must make sure that it is not deployed to any index endpoint.

Parameters
Name Description
request DeleteIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteIndexMetadata

A Task containing the RPC response.
Overrides

DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallSettings)

public override Operation<Empty, DeleteIndexEndpointMetadata> DeleteIndexEndpoint(DeleteIndexEndpointRequest request, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name Description
request DeleteIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteIndexEndpointMetadata

The RPC response.
Overrides

DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallSettings)

public override Task<Operation<Empty, DeleteIndexEndpointMetadata>> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name Description
request DeleteIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteIndexEndpointMetadata

A Task containing the RPC response.
Overrides

DeleteSearchConfig(DeleteSearchConfigRequest, CallSettings)

public override void DeleteSearchConfig(DeleteSearchConfigRequest request, CallSettings callSettings = null)

Deletes a search configuration inside a corpus.

For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist.

Parameters
Name Description
request DeleteSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteSearchConfigAsync(DeleteSearchConfigRequest, CallSettings)

public override Task DeleteSearchConfigAsync(DeleteSearchConfigRequest request, CallSettings callSettings = null)

Deletes a search configuration inside a corpus.

For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist.

Parameters
Name Description
request DeleteSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteSearchHypernym(DeleteSearchHypernymRequest, CallSettings)

public override void DeleteSearchHypernym(DeleteSearchHypernymRequest request, CallSettings callSettings = null)

Deletes a SearchHypernym inside a corpus.

Parameters
Name Description
request DeleteSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteSearchHypernymAsync(DeleteSearchHypernymRequest, CallSettings)

public override Task DeleteSearchHypernymAsync(DeleteSearchHypernymRequest request, CallSettings callSettings = null)

Deletes a SearchHypernym inside a corpus.

Parameters
Name Description
request DeleteSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeployIndex(DeployIndexRequest, CallSettings)

public override Operation<DeployIndexResponse, DeployIndexMetadata> DeployIndex(DeployIndexRequest request, CallSettings callSettings = null)

Deploys an Index to IndexEndpoint.

Parameters
Name Description
request DeployIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDeployIndexResponseDeployIndexMetadata

The RPC response.
Overrides

DeployIndexAsync(DeployIndexRequest, CallSettings)

public override Task<Operation<DeployIndexResponse, DeployIndexMetadata>> DeployIndexAsync(DeployIndexRequest request, CallSettings callSettings = null)

Deploys an Index to IndexEndpoint.

Parameters
Name Description
request DeployIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDeployIndexResponseDeployIndexMetadata

A Task containing the RPC response.
Overrides

GenerateHlsUri(GenerateHlsUriRequest, CallSettings)

public override GenerateHlsUriResponse GenerateHlsUri(GenerateHlsUriRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request GenerateHlsUriRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateHlsUriResponse

The RPC response.
Overrides

GenerateHlsUriAsync(GenerateHlsUriRequest, CallSettings)

public override Task<GenerateHlsUriResponse> GenerateHlsUriAsync(GenerateHlsUriRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request GenerateHlsUriRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateHlsUriResponse

A Task containing the RPC response.
Overrides

GenerateRetrievalUrl(GenerateRetrievalUrlRequest, CallSettings)

public override GenerateRetrievalUrlResponse GenerateRetrievalUrl(GenerateRetrievalUrlRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request GenerateRetrievalUrlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateRetrievalUrlResponse

The RPC response.
Overrides

GenerateRetrievalUrlAsync(GenerateRetrievalUrlRequest, CallSettings)

public override Task<GenerateRetrievalUrlResponse> GenerateRetrievalUrlAsync(GenerateRetrievalUrlRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request GenerateRetrievalUrlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateRetrievalUrlResponse

A Task containing the RPC response.
Overrides

GetAnnotation(GetAnnotationRequest, CallSettings)

public override Annotation GetAnnotation(GetAnnotationRequest request, CallSettings callSettings = null)

Reads annotation inside asset.

Parameters
Name Description
request GetAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Annotation

The RPC response.
Overrides

GetAnnotationAsync(GetAnnotationRequest, CallSettings)

public override Task<Annotation> GetAnnotationAsync(GetAnnotationRequest request, CallSettings callSettings = null)

Reads annotation inside asset.

Parameters
Name Description
request GetAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAnnotation

A Task containing the RPC response.
Overrides

GetAsset(GetAssetRequest, CallSettings)

public override Asset GetAsset(GetAssetRequest request, CallSettings callSettings = null)

Reads an asset inside corpus.

Parameters
Name Description
request GetAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Asset

The RPC response.
Overrides

GetAssetAsync(GetAssetRequest, CallSettings)

public override Task<Asset> GetAssetAsync(GetAssetRequest request, CallSettings callSettings = null)

Reads an asset inside corpus.

Parameters
Name Description
request GetAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAsset

A Task containing the RPC response.
Overrides

GetCollection(GetCollectionRequest, CallSettings)

public override Collection GetCollection(GetCollectionRequest request, CallSettings callSettings = null)

Gets a collection.

Parameters
Name Description
request GetCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Collection

The RPC response.
Overrides

GetCollectionAsync(GetCollectionRequest, CallSettings)

public override Task<Collection> GetCollectionAsync(GetCollectionRequest request, CallSettings callSettings = null)

Gets a collection.

Parameters
Name Description
request GetCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCollection

A Task containing the RPC response.
Overrides

GetCorpus(GetCorpusRequest, CallSettings)

public override Corpus GetCorpus(GetCorpusRequest request, CallSettings callSettings = null)

Gets corpus details inside a project.

Parameters
Name Description
request GetCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Corpus

The RPC response.
Overrides

GetCorpusAsync(GetCorpusRequest, CallSettings)

public override Task<Corpus> GetCorpusAsync(GetCorpusRequest request, CallSettings callSettings = null)

Gets corpus details inside a project.

Parameters
Name Description
request GetCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCorpus

A Task containing the RPC response.
Overrides

GetDataSchema(GetDataSchemaRequest, CallSettings)

public override DataSchema GetDataSchema(GetDataSchemaRequest request, CallSettings callSettings = null)

Gets data schema inside corpus.

Parameters
Name Description
request GetDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataSchema

The RPC response.
Overrides

GetDataSchemaAsync(GetDataSchemaRequest, CallSettings)

public override Task<DataSchema> GetDataSchemaAsync(GetDataSchemaRequest request, CallSettings callSettings = null)

Gets data schema inside corpus.

Parameters
Name Description
request GetDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataSchema

A Task containing the RPC response.
Overrides

GetIndex(GetIndexRequest, CallSettings)

public override Index GetIndex(GetIndexRequest request, CallSettings callSettings = null)

Gets the details of a single Index under a Corpus.

Parameters
Name Description
request GetIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Index

The RPC response.
Overrides

GetIndexAsync(GetIndexRequest, CallSettings)

public override Task<Index> GetIndexAsync(GetIndexRequest request, CallSettings callSettings = null)

Gets the details of a single Index under a Corpus.

Parameters
Name Description
request GetIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskIndex

A Task containing the RPC response.
Overrides

GetIndexEndpoint(GetIndexEndpointRequest, CallSettings)

public override IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name Description
request GetIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
IndexEndpoint

The RPC response.
Overrides

GetIndexEndpointAsync(GetIndexEndpointRequest, CallSettings)

public override Task<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name Description
request GetIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskIndexEndpoint

A Task containing the RPC response.
Overrides

GetSearchConfig(GetSearchConfigRequest, CallSettings)

public override SearchConfig GetSearchConfig(GetSearchConfigRequest request, CallSettings callSettings = null)

Gets a search configuration inside a corpus.

Parameters
Name Description
request GetSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SearchConfig

The RPC response.
Overrides

GetSearchConfigAsync(GetSearchConfigRequest, CallSettings)

public override Task<SearchConfig> GetSearchConfigAsync(GetSearchConfigRequest request, CallSettings callSettings = null)

Gets a search configuration inside a corpus.

Parameters
Name Description
request GetSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSearchConfig

A Task containing the RPC response.
Overrides

GetSearchHypernym(GetSearchHypernymRequest, CallSettings)

public override SearchHypernym GetSearchHypernym(GetSearchHypernymRequest request, CallSettings callSettings = null)

Gets a SearchHypernym inside a corpus.

Parameters
Name Description
request GetSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SearchHypernym

The RPC response.
Overrides

GetSearchHypernymAsync(GetSearchHypernymRequest, CallSettings)

public override Task<SearchHypernym> GetSearchHypernymAsync(GetSearchHypernymRequest request, CallSettings callSettings = null)

Gets a SearchHypernym inside a corpus.

Parameters
Name Description
request GetSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSearchHypernym

A Task containing the RPC response.
Overrides

ImportAssets(ImportAssetsRequest, CallSettings)

public override Operation<ImportAssetsResponse, ImportAssetsMetadata> ImportAssets(ImportAssetsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ImportAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationImportAssetsResponseImportAssetsMetadata

The RPC response.
Overrides

ImportAssetsAsync(ImportAssetsRequest, CallSettings)

public override Task<Operation<ImportAssetsResponse, ImportAssetsMetadata>> ImportAssetsAsync(ImportAssetsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ImportAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationImportAssetsResponseImportAssetsMetadata

A Task containing the RPC response.
Overrides

IndexAsset(IndexAssetRequest, CallSettings)

public override Operation<IndexAssetResponse, IndexAssetMetadata> IndexAsset(IndexAssetRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request IndexAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexAssetResponseIndexAssetMetadata

The RPC response.
Overrides

IndexAssetAsync(IndexAssetRequest, CallSettings)

public override Task<Operation<IndexAssetResponse, IndexAssetMetadata>> IndexAssetAsync(IndexAssetRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request IndexAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexAssetResponseIndexAssetMetadata

A Task containing the RPC response.
Overrides

IngestAsset(CallSettings, BidirectionalStreamingSettings)

public override WarehouseClient.IngestAssetStream IngestAsset(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)

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).

Parameters
Name Description
callSettings CallSettings

If not null, applies overrides to this RPC call.
streamingSettings BidirectionalStreamingSettings

If not null, applies streaming overrides to this RPC call.
Returns
Type Description
WarehouseClientIngestAssetStream

The client-server stream.
Overrides

ListAnnotations(ListAnnotationsRequest, CallSettings)

public override PagedEnumerable<ListAnnotationsResponse, Annotation> ListAnnotations(ListAnnotationsRequest request, CallSettings callSettings = null)

Lists a list of annotations inside asset.

Parameters
Name Description
request ListAnnotationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAnnotationsResponseAnnotation

A pageable sequence of Annotation resources.
Overrides

ListAnnotationsAsync(ListAnnotationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> ListAnnotationsAsync(ListAnnotationsRequest request, CallSettings callSettings = null)

Lists a list of annotations inside asset.

Parameters
Name Description
request ListAnnotationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAnnotationsResponseAnnotation

A pageable asynchronous sequence of Annotation resources.
Overrides

ListAssets(ListAssetsRequest, CallSettings)

public override PagedEnumerable<ListAssetsResponse, Asset> ListAssets(ListAssetsRequest request, CallSettings callSettings = null)

Lists an list of assets inside corpus.

Parameters
Name Description
request ListAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAssetsResponseAsset

A pageable sequence of Asset resources.
Overrides

ListAssetsAsync(ListAssetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAssetsResponse, Asset> ListAssetsAsync(ListAssetsRequest request, CallSettings callSettings = null)

Lists an list of assets inside corpus.

Parameters
Name Description
request ListAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAssetsResponseAsset

A pageable asynchronous sequence of Asset resources.
Overrides

ListCollections(ListCollectionsRequest, CallSettings)

public override PagedEnumerable<ListCollectionsResponse, Collection> ListCollections(ListCollectionsRequest request, CallSettings callSettings = null)

Lists collections inside a corpus.

Parameters
Name Description
request ListCollectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListCollectionsResponseCollection

A pageable sequence of Collection resources.
Overrides

ListCollectionsAsync(ListCollectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCollectionsResponse, Collection> ListCollectionsAsync(ListCollectionsRequest request, CallSettings callSettings = null)

Lists collections inside a corpus.

Parameters
Name Description
request ListCollectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListCollectionsResponseCollection

A pageable asynchronous sequence of Collection resources.
Overrides

ListCorpora(ListCorporaRequest, CallSettings)

public override PagedEnumerable<ListCorporaResponse, Corpus> ListCorpora(ListCorporaRequest request, CallSettings callSettings = null)

Lists all corpora in a project.

Parameters
Name Description
request ListCorporaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListCorporaResponseCorpus

A pageable sequence of Corpus resources.
Overrides

ListCorporaAsync(ListCorporaRequest, CallSettings)

public override PagedAsyncEnumerable<ListCorporaResponse, Corpus> ListCorporaAsync(ListCorporaRequest request, CallSettings callSettings = null)

Lists all corpora in a project.

Parameters
Name Description
request ListCorporaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListCorporaResponseCorpus

A pageable asynchronous sequence of Corpus resources.
Overrides

ListDataSchemas(ListDataSchemasRequest, CallSettings)

public override PagedEnumerable<ListDataSchemasResponse, DataSchema> ListDataSchemas(ListDataSchemasRequest request, CallSettings callSettings = null)

Lists a list of data schemas inside corpus.

Parameters
Name Description
request ListDataSchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDataSchemasResponseDataSchema

A pageable sequence of DataSchema resources.
Overrides

ListDataSchemasAsync(ListDataSchemasRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataSchemasResponse, DataSchema> ListDataSchemasAsync(ListDataSchemasRequest request, CallSettings callSettings = null)

Lists a list of data schemas inside corpus.

Parameters
Name Description
request ListDataSchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDataSchemasResponseDataSchema

A pageable asynchronous sequence of DataSchema resources.
Overrides

ListIndexEndpoints(ListIndexEndpointsRequest, CallSettings)

public override PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpoints(ListIndexEndpointsRequest request, CallSettings callSettings = null)

Lists all IndexEndpoints in a project.

Parameters
Name Description
request ListIndexEndpointsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListIndexEndpointsResponseIndexEndpoint

A pageable sequence of IndexEndpoint resources.
Overrides

ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallSettings)

public override PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, CallSettings callSettings = null)

Lists all IndexEndpoints in a project.

Parameters
Name Description
request ListIndexEndpointsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListIndexEndpointsResponseIndexEndpoint

A pageable asynchronous sequence of IndexEndpoint resources.
Overrides

ListIndexes(ListIndexesRequest, CallSettings)

public override PagedEnumerable<ListIndexesResponse, Index> ListIndexes(ListIndexesRequest request, CallSettings callSettings = null)

List all Indexes in a given Corpus.

Parameters
Name Description
request ListIndexesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListIndexesResponseIndex

A pageable sequence of Index resources.
Overrides

ListIndexesAsync(ListIndexesRequest, CallSettings)

public override PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(ListIndexesRequest request, CallSettings callSettings = null)

List all Indexes in a given Corpus.

Parameters
Name Description
request ListIndexesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListIndexesResponseIndex

A pageable asynchronous sequence of Index resources.
Overrides

ListSearchConfigs(ListSearchConfigsRequest, CallSettings)

public override PagedEnumerable<ListSearchConfigsResponse, SearchConfig> ListSearchConfigs(ListSearchConfigsRequest request, CallSettings callSettings = null)

Lists all search configurations inside a corpus.

Parameters
Name Description
request ListSearchConfigsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSearchConfigsResponseSearchConfig

A pageable sequence of SearchConfig resources.
Overrides

ListSearchConfigsAsync(ListSearchConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSearchConfigsResponse, SearchConfig> ListSearchConfigsAsync(ListSearchConfigsRequest request, CallSettings callSettings = null)

Lists all search configurations inside a corpus.

Parameters
Name Description
request ListSearchConfigsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSearchConfigsResponseSearchConfig

A pageable asynchronous sequence of SearchConfig resources.
Overrides

ListSearchHypernyms(ListSearchHypernymsRequest, CallSettings)

public override PagedEnumerable<ListSearchHypernymsResponse, SearchHypernym> ListSearchHypernyms(ListSearchHypernymsRequest request, CallSettings callSettings = null)

Lists SearchHypernyms inside a corpus.

Parameters
Name Description
request ListSearchHypernymsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSearchHypernymsResponseSearchHypernym

A pageable sequence of SearchHypernym resources.
Overrides

ListSearchHypernymsAsync(ListSearchHypernymsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSearchHypernymsResponse, SearchHypernym> ListSearchHypernymsAsync(ListSearchHypernymsRequest request, CallSettings callSettings = null)

Lists SearchHypernyms inside a corpus.

Parameters
Name Description
request ListSearchHypernymsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSearchHypernymsResponseSearchHypernym

A pageable asynchronous sequence of SearchHypernym resources.
Overrides

RemoveCollectionItem(RemoveCollectionItemRequest, CallSettings)

public override RemoveCollectionItemResponse RemoveCollectionItem(RemoveCollectionItemRequest request, CallSettings callSettings = null)

Removes an item from a collection.

Parameters
Name Description
request RemoveCollectionItemRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RemoveCollectionItemResponse

The RPC response.
Overrides

RemoveCollectionItemAsync(RemoveCollectionItemRequest, CallSettings)

public override Task<RemoveCollectionItemResponse> RemoveCollectionItemAsync(RemoveCollectionItemRequest request, CallSettings callSettings = null)

Removes an item from a collection.

Parameters
Name Description
request RemoveCollectionItemRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRemoveCollectionItemResponse

A Task containing the RPC response.
Overrides

RemoveIndexAsset(RemoveIndexAssetRequest, CallSettings)

public override Operation<RemoveIndexAssetResponse, RemoveIndexAssetMetadata> RemoveIndexAsset(RemoveIndexAssetRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request RemoveIndexAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationRemoveIndexAssetResponseRemoveIndexAssetMetadata

The RPC response.
Overrides

RemoveIndexAssetAsync(RemoveIndexAssetRequest, CallSettings)

public override Task<Operation<RemoveIndexAssetResponse, RemoveIndexAssetMetadata>> RemoveIndexAssetAsync(RemoveIndexAssetRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request RemoveIndexAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationRemoveIndexAssetResponseRemoveIndexAssetMetadata

A Task containing the RPC response.
Overrides

SearchAssets(SearchAssetsRequest, CallSettings)

public override PagedEnumerable<SearchAssetsResponse, SearchResultItem> SearchAssets(SearchAssetsRequest request, CallSettings callSettings = null)

Search media asset.

Parameters
Name Description
request SearchAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchAssetsResponseSearchResultItem

A pageable sequence of SearchResultItem resources.
Overrides

SearchAssetsAsync(SearchAssetsRequest, CallSettings)

public override PagedAsyncEnumerable<SearchAssetsResponse, SearchResultItem> SearchAssetsAsync(SearchAssetsRequest request, CallSettings callSettings = null)

Search media asset.

Parameters
Name Description
request SearchAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchAssetsResponseSearchResultItem

A pageable asynchronous sequence of SearchResultItem resources.
Overrides

SearchIndexEndpoint(SearchIndexEndpointRequest, CallSettings)

public override PagedEnumerable<SearchIndexEndpointResponse, SearchResultItem> SearchIndexEndpoint(SearchIndexEndpointRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SearchIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchIndexEndpointResponseSearchResultItem

A pageable sequence of SearchResultItem resources.
Overrides

SearchIndexEndpointAsync(SearchIndexEndpointRequest, CallSettings)

public override PagedAsyncEnumerable<SearchIndexEndpointResponse, SearchResultItem> SearchIndexEndpointAsync(SearchIndexEndpointRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SearchIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchIndexEndpointResponseSearchResultItem

A pageable asynchronous sequence of SearchResultItem resources.
Overrides

UndeployIndex(UndeployIndexRequest, CallSettings)

public override Operation<UndeployIndexResponse, UndeployIndexMetadata> UndeployIndex(UndeployIndexRequest request, CallSettings callSettings = null)

Undeploys an Index from IndexEndpoint.

Parameters
Name Description
request UndeployIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationUndeployIndexResponseUndeployIndexMetadata

The RPC response.
Overrides

UndeployIndexAsync(UndeployIndexRequest, CallSettings)

public override Task<Operation<UndeployIndexResponse, UndeployIndexMetadata>> UndeployIndexAsync(UndeployIndexRequest request, CallSettings callSettings = null)

Undeploys an Index from IndexEndpoint.

Parameters
Name Description
request UndeployIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationUndeployIndexResponseUndeployIndexMetadata

A Task containing the RPC response.
Overrides

UpdateAnnotation(UpdateAnnotationRequest, CallSettings)

public override Annotation UpdateAnnotation(UpdateAnnotationRequest request, CallSettings callSettings = null)

Updates annotation inside asset.

Parameters
Name Description
request UpdateAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Annotation

The RPC response.
Overrides

UpdateAnnotationAsync(UpdateAnnotationRequest, CallSettings)

public override Task<Annotation> UpdateAnnotationAsync(UpdateAnnotationRequest request, CallSettings callSettings = null)

Updates annotation inside asset.

Parameters
Name Description
request UpdateAnnotationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAnnotation

A Task containing the RPC response.
Overrides

UpdateAsset(UpdateAssetRequest, CallSettings)

public override Asset UpdateAsset(UpdateAssetRequest request, CallSettings callSettings = null)

Updates an asset inside corpus.

Parameters
Name Description
request UpdateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Asset

The RPC response.
Overrides

UpdateAssetAsync(UpdateAssetRequest, CallSettings)

public override Task<Asset> UpdateAssetAsync(UpdateAssetRequest request, CallSettings callSettings = null)

Updates an asset inside corpus.

Parameters
Name Description
request UpdateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAsset

A Task containing the RPC response.
Overrides

UpdateCollection(UpdateCollectionRequest, CallSettings)

public override Collection UpdateCollection(UpdateCollectionRequest request, CallSettings callSettings = null)

Updates a collection.

Parameters
Name Description
request UpdateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Collection

The RPC response.
Overrides

UpdateCollectionAsync(UpdateCollectionRequest, CallSettings)

public override Task<Collection> UpdateCollectionAsync(UpdateCollectionRequest request, CallSettings callSettings = null)

Updates a collection.

Parameters
Name Description
request UpdateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCollection

A Task containing the RPC response.
Overrides

UpdateCorpus(UpdateCorpusRequest, CallSettings)

public override Corpus UpdateCorpus(UpdateCorpusRequest request, CallSettings callSettings = null)

Updates a corpus in a project.

Parameters
Name Description
request UpdateCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Corpus

The RPC response.
Overrides

UpdateCorpusAsync(UpdateCorpusRequest, CallSettings)

public override Task<Corpus> UpdateCorpusAsync(UpdateCorpusRequest request, CallSettings callSettings = null)

Updates a corpus in a project.

Parameters
Name Description
request UpdateCorpusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCorpus

A Task containing the RPC response.
Overrides

UpdateDataSchema(UpdateDataSchemaRequest, CallSettings)

public override DataSchema UpdateDataSchema(UpdateDataSchemaRequest request, CallSettings callSettings = null)

Updates data schema inside corpus.

Parameters
Name Description
request UpdateDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataSchema

The RPC response.
Overrides

UpdateDataSchemaAsync(UpdateDataSchemaRequest, CallSettings)

public override Task<DataSchema> UpdateDataSchemaAsync(UpdateDataSchemaRequest request, CallSettings callSettings = null)

Updates data schema inside corpus.

Parameters
Name Description
request UpdateDataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataSchema

A Task containing the RPC response.
Overrides

UpdateIndex(UpdateIndexRequest, CallSettings)

public override Operation<Index, UpdateIndexMetadata> UpdateIndex(UpdateIndexRequest request, CallSettings callSettings = null)

Updates an Index under the corpus. Users can perform a metadata-only update or trigger a full index rebuild with different update_mask values.

Parameters
Name Description
request UpdateIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexUpdateIndexMetadata

The RPC response.
Overrides

UpdateIndexAsync(UpdateIndexRequest, CallSettings)

public override Task<Operation<Index, UpdateIndexMetadata>> UpdateIndexAsync(UpdateIndexRequest request, CallSettings callSettings = null)

Updates an Index under the corpus. Users can perform a metadata-only update or trigger a full index rebuild with different update_mask values.

Parameters
Name Description
request UpdateIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexUpdateIndexMetadata

A Task containing the RPC response.
Overrides

UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallSettings)

public override Operation<IndexEndpoint, UpdateIndexEndpointMetadata> UpdateIndexEndpoint(UpdateIndexEndpointRequest request, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name Description
request UpdateIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexEndpointUpdateIndexEndpointMetadata

The RPC response.
Overrides

UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallSettings)

public override Task<Operation<IndexEndpoint, UpdateIndexEndpointMetadata>> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name Description
request UpdateIndexEndpointRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexEndpointUpdateIndexEndpointMetadata

A Task containing the RPC response.
Overrides

UpdateSearchConfig(UpdateSearchConfigRequest, CallSettings)

public override SearchConfig UpdateSearchConfig(UpdateSearchConfigRequest request, CallSettings callSettings = null)

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.
Parameters
Name Description
request UpdateSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SearchConfig

The RPC response.
Overrides

UpdateSearchConfigAsync(UpdateSearchConfigRequest, CallSettings)

public override Task<SearchConfig> UpdateSearchConfigAsync(UpdateSearchConfigRequest request, CallSettings callSettings = null)

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.
Parameters
Name Description
request UpdateSearchConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSearchConfig

A Task containing the RPC response.
Overrides

UpdateSearchHypernym(UpdateSearchHypernymRequest, CallSettings)

public override SearchHypernym UpdateSearchHypernym(UpdateSearchHypernymRequest request, CallSettings callSettings = null)

Updates a SearchHypernym inside a corpus.

Parameters
Name Description
request UpdateSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SearchHypernym

The RPC response.
Overrides

UpdateSearchHypernymAsync(UpdateSearchHypernymRequest, CallSettings)

public override Task<SearchHypernym> UpdateSearchHypernymAsync(UpdateSearchHypernymRequest request, CallSettings callSettings = null)

Updates a SearchHypernym inside a corpus.

Parameters
Name Description
request UpdateSearchHypernymRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSearchHypernym

A Task containing the RPC response.
Overrides

UploadAsset(UploadAssetRequest, CallSettings)

public override Operation<UploadAssetResponse, UploadAssetMetadata> UploadAsset(UploadAssetRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UploadAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationUploadAssetResponseUploadAssetMetadata

The RPC response.
Overrides

UploadAssetAsync(UploadAssetRequest, CallSettings)

public override Task<Operation<UploadAssetResponse, UploadAssetMetadata>> UploadAssetAsync(UploadAssetRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UploadAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationUploadAssetResponseUploadAssetMetadata

A Task containing the RPC response.
Overrides

ViewCollectionItems(ViewCollectionItemsRequest, CallSettings)

public override PagedEnumerable<ViewCollectionItemsResponse, CollectionItem> ViewCollectionItems(ViewCollectionItemsRequest request, CallSettings callSettings = null)

View items inside a collection.

Parameters
Name Description
request ViewCollectionItemsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableViewCollectionItemsResponseCollectionItem

A pageable sequence of CollectionItem resources.
Overrides

ViewCollectionItemsAsync(ViewCollectionItemsRequest, CallSettings)

public override PagedAsyncEnumerable<ViewCollectionItemsResponse, CollectionItem> ViewCollectionItemsAsync(ViewCollectionItemsRequest request, CallSettings callSettings = null)

View items inside a collection.

Parameters
Name Description
request ViewCollectionItemsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableViewCollectionItemsResponseCollectionItem

A pageable asynchronous sequence of CollectionItem resources.
Overrides

ViewIndexedAssets(ViewIndexedAssetsRequest, CallSettings)

public override PagedEnumerable<ViewIndexedAssetsResponse, IndexedAsset> ViewIndexedAssets(ViewIndexedAssetsRequest request, CallSettings callSettings = null)

Lists assets inside an index.

Parameters
Name Description
request ViewIndexedAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableViewIndexedAssetsResponseIndexedAsset

A pageable sequence of IndexedAsset resources.
Overrides

ViewIndexedAssetsAsync(ViewIndexedAssetsRequest, CallSettings)

public override PagedAsyncEnumerable<ViewIndexedAssetsResponse, IndexedAsset> ViewIndexedAssetsAsync(ViewIndexedAssetsRequest request, CallSettings callSettings = null)

Lists assets inside an index.

Parameters
Name Description
request ViewIndexedAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableViewIndexedAssetsResponseIndexedAsset

A pageable asynchronous sequence of IndexedAsset resources.
Overrides