public class Warehouse.WarehouseClient : ClientBase<Warehouse.WarehouseClient>Reference documentation and code samples for the Vision AI v1 API class Warehouse.WarehouseClient.
Client for Warehouse
Namespace
Google.Cloud.VisionAI.V1Assembly
Google.Cloud.VisionAI.V1.dll
Constructors
WarehouseClient()
protected WarehouseClient()Protected parameterless constructor to allow creation of test doubles.
WarehouseClient(CallInvoker)
public WarehouseClient(CallInvoker callInvoker)Creates a new client for Warehouse that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
WarehouseClient(ChannelBase)
public WarehouseClient(ChannelBase channel)Creates a new client for Warehouse
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
WarehouseClient(ClientBaseConfiguration)
protected WarehouseClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
AddCollectionItem(AddCollectionItemRequest, CallOptions)
public virtual AddCollectionItemResponse AddCollectionItem(AddCollectionItemRequest request, CallOptions options)Adds an item into a Collection.
| Parameters | |
|---|---|
| Name | Description |
request |
AddCollectionItemRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AddCollectionItemResponse |
The response received from the server. |
AddCollectionItem(AddCollectionItemRequest, Metadata, DateTime?, CancellationToken)
public virtual AddCollectionItemResponse AddCollectionItem(AddCollectionItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Adds an item into a Collection.
| Parameters | |
|---|---|
| Name | Description |
request |
AddCollectionItemRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AddCollectionItemResponse |
The response received from the server. |
AddCollectionItemAsync(AddCollectionItemRequest, CallOptions)
public virtual AsyncUnaryCall<AddCollectionItemResponse> AddCollectionItemAsync(AddCollectionItemRequest request, CallOptions options)Adds an item into a Collection.
| Parameters | |
|---|---|
| Name | Description |
request |
AddCollectionItemRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAddCollectionItemResponse |
The call object. |
AddCollectionItemAsync(AddCollectionItemRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<AddCollectionItemResponse> AddCollectionItemAsync(AddCollectionItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Adds an item into a Collection.
| Parameters | |
|---|---|
| Name | Description |
request |
AddCollectionItemRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAddCollectionItemResponse |
The call object. |
AnalyzeAsset(AnalyzeAssetRequest, CallOptions)
public virtual Operation AnalyzeAsset(AnalyzeAssetRequest request, CallOptions options)Analyze asset to power search capability.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AnalyzeAsset(AnalyzeAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation AnalyzeAsset(AnalyzeAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Analyze asset to power search capability.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AnalyzeAssetAsync(AnalyzeAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> AnalyzeAssetAsync(AnalyzeAssetRequest request, CallOptions options)Analyze asset to power search capability.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
AnalyzeAssetAsync(AnalyzeAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> AnalyzeAssetAsync(AnalyzeAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Analyze asset to power search capability.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
AnalyzeCorpus(AnalyzeCorpusRequest, CallOptions)
public virtual Operation AnalyzeCorpus(AnalyzeCorpusRequest request, CallOptions options)Analyzes a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AnalyzeCorpus(AnalyzeCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation AnalyzeCorpus(AnalyzeCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Analyzes a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AnalyzeCorpusAsync(AnalyzeCorpusRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> AnalyzeCorpusAsync(AnalyzeCorpusRequest request, CallOptions options)Analyzes a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
AnalyzeCorpusAsync(AnalyzeCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> AnalyzeCorpusAsync(AnalyzeCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Analyzes a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
AnalyzeCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ClipAsset(ClipAssetRequest, CallOptions)
public virtual ClipAssetResponse ClipAsset(ClipAssetRequest request, CallOptions options)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 |
ClipAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ClipAssetResponse |
The response received from the server. |
ClipAsset(ClipAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual ClipAssetResponse ClipAsset(ClipAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
ClipAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ClipAssetResponse |
The response received from the server. |
ClipAssetAsync(ClipAssetRequest, CallOptions)
public virtual AsyncUnaryCall<ClipAssetResponse> ClipAssetAsync(ClipAssetRequest request, CallOptions options)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 |
ClipAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallClipAssetResponse |
The call object. |
ClipAssetAsync(ClipAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ClipAssetResponse> ClipAssetAsync(ClipAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
ClipAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallClipAssetResponse |
The call object. |
CreateAnnotation(CreateAnnotationRequest, CallOptions)
public virtual Annotation CreateAnnotation(CreateAnnotationRequest request, CallOptions options)Creates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Annotation |
The response received from the server. |
CreateAnnotation(CreateAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual Annotation CreateAnnotation(CreateAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Annotation |
The response received from the server. |
CreateAnnotationAsync(CreateAnnotationRequest, CallOptions)
public virtual AsyncUnaryCall<Annotation> CreateAnnotationAsync(CreateAnnotationRequest request, CallOptions options)Creates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAnnotation |
The call object. |
CreateAnnotationAsync(CreateAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Annotation> CreateAnnotationAsync(CreateAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAnnotation |
The call object. |
CreateAsset(CreateAssetRequest, CallOptions)
public virtual Asset CreateAsset(CreateAssetRequest request, CallOptions options)Creates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Asset |
The response received from the server. |
CreateAsset(CreateAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Asset CreateAsset(CreateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Asset |
The response received from the server. |
CreateAssetAsync(CreateAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Asset> CreateAssetAsync(CreateAssetRequest request, CallOptions options)Creates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAsset |
The call object. |
CreateAssetAsync(CreateAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Asset> CreateAssetAsync(CreateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAsset |
The call object. |
CreateCollection(CreateCollectionRequest, CallOptions)
public virtual Operation CreateCollection(CreateCollectionRequest request, CallOptions options)Creates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateCollection(CreateCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateCollection(CreateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateCollectionAsync(CreateCollectionRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateCollectionAsync(CreateCollectionRequest request, CallOptions options)Creates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateCollectionAsync(CreateCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateCollectionAsync(CreateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateCorpus(CreateCorpusRequest, CallOptions)
public virtual Operation CreateCorpus(CreateCorpusRequest request, CallOptions options)Creates a corpus inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateCorpus(CreateCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateCorpus(CreateCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a corpus inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateCorpusAsync(CreateCorpusRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateCorpusAsync(CreateCorpusRequest request, CallOptions options)Creates a corpus inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateCorpusAsync(CreateCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateCorpusAsync(CreateCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a corpus inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateDataSchema(CreateDataSchemaRequest, CallOptions)
public virtual DataSchema CreateDataSchema(CreateDataSchemaRequest request, CallOptions options)Creates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
DataSchema |
The response received from the server. |
CreateDataSchema(CreateDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual DataSchema CreateDataSchema(CreateDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
DataSchema |
The response received from the server. |
CreateDataSchemaAsync(CreateDataSchemaRequest, CallOptions)
public virtual AsyncUnaryCall<DataSchema> CreateDataSchemaAsync(CreateDataSchemaRequest request, CallOptions options)Creates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDataSchema |
The call object. |
CreateDataSchemaAsync(CreateDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DataSchema> CreateDataSchemaAsync(CreateDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDataSchema |
The call object. |
CreateIAMPolicyClient()
public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
IAMPolicyIAMPolicyClient |
A new IAMPolicy.IAMPolicyClient for the same target as this client. |
CreateIndex(CreateIndexRequest, CallOptions)
public virtual Operation CreateIndex(CreateIndexRequest request, CallOptions options)Creates an Index under the corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateIndex(CreateIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateIndex(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an Index under the corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateIndexAsync(CreateIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, CallOptions options)Creates an Index under the corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateIndexAsync(CreateIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an Index under the corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateIndexEndpoint(CreateIndexEndpointRequest, CallOptions)
public virtual Operation CreateIndexEndpoint(CreateIndexEndpointRequest request, CallOptions options)Creates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateIndexEndpoint(CreateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateIndexEndpoint(CreateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, CallOptions options)Creates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateIndexEndpointAsync(CreateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
CreateSearchConfig(CreateSearchConfigRequest, CallOptions)
public virtual SearchConfig CreateSearchConfig(CreateSearchConfigRequest request, CallOptions options)Creates a search configuration inside a corpus.
Please follow the rules below to create a valid CreateSearchConfigRequest. --- General Rules ---
- Request.search_config_id must not be associated with an existing SearchConfig.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
CreateSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchConfig |
The response received from the server. |
CreateSearchConfig(CreateSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchConfig CreateSearchConfig(CreateSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a search configuration inside a corpus.
Please follow the rules below to create a valid CreateSearchConfigRequest. --- General Rules ---
- Request.search_config_id must not be associated with an existing SearchConfig.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
CreateSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchConfig |
The response received from the server. |
CreateSearchConfigAsync(CreateSearchConfigRequest, CallOptions)
public virtual AsyncUnaryCall<SearchConfig> CreateSearchConfigAsync(CreateSearchConfigRequest request, CallOptions options)Creates a search configuration inside a corpus.
Please follow the rules below to create a valid CreateSearchConfigRequest. --- General Rules ---
- Request.search_config_id must not be associated with an existing SearchConfig.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
CreateSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchConfig |
The call object. |
CreateSearchConfigAsync(CreateSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchConfig> CreateSearchConfigAsync(CreateSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a search configuration inside a corpus.
Please follow the rules below to create a valid CreateSearchConfigRequest. --- General Rules ---
- Request.search_config_id must not be associated with an existing SearchConfig.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
CreateSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchConfig |
The call object. |
CreateSearchHypernym(CreateSearchHypernymRequest, CallOptions)
public virtual SearchHypernym CreateSearchHypernym(CreateSearchHypernymRequest request, CallOptions options)Creates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchHypernym |
The response received from the server. |
CreateSearchHypernym(CreateSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchHypernym CreateSearchHypernym(CreateSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchHypernym |
The response received from the server. |
CreateSearchHypernymAsync(CreateSearchHypernymRequest, CallOptions)
public virtual AsyncUnaryCall<SearchHypernym> CreateSearchHypernymAsync(CreateSearchHypernymRequest request, CallOptions options)Creates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchHypernym |
The call object. |
CreateSearchHypernymAsync(CreateSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchHypernym> CreateSearchHypernymAsync(CreateSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchHypernym |
The call object. |
DeleteAnnotation(DeleteAnnotationRequest, CallOptions)
public virtual Empty DeleteAnnotation(DeleteAnnotationRequest request, CallOptions options)Deletes annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteAnnotation(DeleteAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteAnnotation(DeleteAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteAnnotationAsync(DeleteAnnotationRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteAnnotationAsync(DeleteAnnotationRequest request, CallOptions options)Deletes annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteAnnotationAsync(DeleteAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteAnnotationAsync(DeleteAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteAsset(DeleteAssetRequest, CallOptions)
public virtual Operation DeleteAsset(DeleteAssetRequest request, CallOptions options)Deletes asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteAsset(DeleteAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteAsset(DeleteAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteAssetAsync(DeleteAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteAssetAsync(DeleteAssetRequest request, CallOptions options)Deletes asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteAssetAsync(DeleteAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteAssetAsync(DeleteAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteCollection(DeleteCollectionRequest, CallOptions)
public virtual Operation DeleteCollection(DeleteCollectionRequest request, CallOptions options)Deletes a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteCollection(DeleteCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteCollection(DeleteCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteCollectionAsync(DeleteCollectionRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteCollectionAsync(DeleteCollectionRequest request, CallOptions options)Deletes a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteCollectionAsync(DeleteCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteCollectionAsync(DeleteCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteCorpus(DeleteCorpusRequest, CallOptions)
public virtual Empty DeleteCorpus(DeleteCorpusRequest request, CallOptions options)Deletes a corpus only if its empty. Returns empty response.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteCorpus(DeleteCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteCorpus(DeleteCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a corpus only if its empty. Returns empty response.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteCorpusAsync(DeleteCorpusRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteCorpusAsync(DeleteCorpusRequest request, CallOptions options)Deletes a corpus only if its empty. Returns empty response.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteCorpusAsync(DeleteCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteCorpusAsync(DeleteCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a corpus only if its empty. Returns empty response.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteDataSchema(DeleteDataSchemaRequest, CallOptions)
public virtual Empty DeleteDataSchema(DeleteDataSchemaRequest request, CallOptions options)Deletes data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteDataSchema(DeleteDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteDataSchema(DeleteDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteDataSchemaAsync(DeleteDataSchemaRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteDataSchemaAsync(DeleteDataSchemaRequest request, CallOptions options)Deletes data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteDataSchemaAsync(DeleteDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteDataSchemaAsync(DeleteDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteIndex(DeleteIndexRequest, CallOptions)
public virtual Operation DeleteIndex(DeleteIndexRequest request, CallOptions options)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 |
DeleteIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteIndex(DeleteIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteIndex(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
DeleteIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteIndexAsync(DeleteIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteIndexAsync(DeleteIndexRequest request, CallOptions options)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 |
DeleteIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteIndexAsync(DeleteIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteIndexAsync(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
DeleteIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallOptions)
public virtual Operation DeleteIndexEndpoint(DeleteIndexEndpointRequest request, CallOptions options)Deletes an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteIndexEndpoint(DeleteIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteIndexEndpoint(DeleteIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, CallOptions options)Deletes an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteSearchConfig(DeleteSearchConfigRequest, CallOptions)
public virtual Empty DeleteSearchConfig(DeleteSearchConfigRequest request, CallOptions options)Deletes a search configuration inside a corpus.
For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteSearchConfig(DeleteSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteSearchConfig(DeleteSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a search configuration inside a corpus.
For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteSearchConfigAsync(DeleteSearchConfigRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteSearchConfigAsync(DeleteSearchConfigRequest request, CallOptions options)Deletes a search configuration inside a corpus.
For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteSearchConfigAsync(DeleteSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteSearchConfigAsync(DeleteSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a search configuration inside a corpus.
For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteSearchHypernym(DeleteSearchHypernymRequest, CallOptions)
public virtual Empty DeleteSearchHypernym(DeleteSearchHypernymRequest request, CallOptions options)Deletes a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteSearchHypernym(DeleteSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteSearchHypernym(DeleteSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteSearchHypernymAsync(DeleteSearchHypernymRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteSearchHypernymAsync(DeleteSearchHypernymRequest request, CallOptions options)Deletes a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteSearchHypernymAsync(DeleteSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteSearchHypernymAsync(DeleteSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeployIndex(DeployIndexRequest, CallOptions)
public virtual Operation DeployIndex(DeployIndexRequest request, CallOptions options)Deploys an Index to IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeployIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeployIndex(DeployIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeployIndex(DeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deploys an Index to IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeployIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeployIndexAsync(DeployIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeployIndexAsync(DeployIndexRequest request, CallOptions options)Deploys an Index to IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeployIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeployIndexAsync(DeployIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeployIndexAsync(DeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deploys an Index to IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeployIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
GenerateHlsUri(GenerateHlsUriRequest, CallOptions)
public virtual GenerateHlsUriResponse GenerateHlsUri(GenerateHlsUriRequest request, CallOptions options)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 |
GenerateHlsUriRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
GenerateHlsUriResponse |
The response received from the server. |
GenerateHlsUri(GenerateHlsUriRequest, Metadata, DateTime?, CancellationToken)
public virtual GenerateHlsUriResponse GenerateHlsUri(GenerateHlsUriRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
GenerateHlsUriRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
GenerateHlsUriResponse |
The response received from the server. |
GenerateHlsUriAsync(GenerateHlsUriRequest, CallOptions)
public virtual AsyncUnaryCall<GenerateHlsUriResponse> GenerateHlsUriAsync(GenerateHlsUriRequest request, CallOptions options)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 |
GenerateHlsUriRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGenerateHlsUriResponse |
The call object. |
GenerateHlsUriAsync(GenerateHlsUriRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<GenerateHlsUriResponse> GenerateHlsUriAsync(GenerateHlsUriRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
GenerateHlsUriRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGenerateHlsUriResponse |
The call object. |
GenerateRetrievalUrl(GenerateRetrievalUrlRequest, CallOptions)
public virtual GenerateRetrievalUrlResponse GenerateRetrievalUrl(GenerateRetrievalUrlRequest request, CallOptions options)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 |
GenerateRetrievalUrlRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
GenerateRetrievalUrlResponse |
The response received from the server. |
GenerateRetrievalUrl(GenerateRetrievalUrlRequest, Metadata, DateTime?, CancellationToken)
public virtual GenerateRetrievalUrlResponse GenerateRetrievalUrl(GenerateRetrievalUrlRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
GenerateRetrievalUrlRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
GenerateRetrievalUrlResponse |
The response received from the server. |
GenerateRetrievalUrlAsync(GenerateRetrievalUrlRequest, CallOptions)
public virtual AsyncUnaryCall<GenerateRetrievalUrlResponse> GenerateRetrievalUrlAsync(GenerateRetrievalUrlRequest request, CallOptions options)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 |
GenerateRetrievalUrlRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGenerateRetrievalUrlResponse |
The call object. |
GenerateRetrievalUrlAsync(GenerateRetrievalUrlRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<GenerateRetrievalUrlResponse> GenerateRetrievalUrlAsync(GenerateRetrievalUrlRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
GenerateRetrievalUrlRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGenerateRetrievalUrlResponse |
The call object. |
GetAnnotation(GetAnnotationRequest, CallOptions)
public virtual Annotation GetAnnotation(GetAnnotationRequest request, CallOptions options)Reads annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Annotation |
The response received from the server. |
GetAnnotation(GetAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual Annotation GetAnnotation(GetAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Reads annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Annotation |
The response received from the server. |
GetAnnotationAsync(GetAnnotationRequest, CallOptions)
public virtual AsyncUnaryCall<Annotation> GetAnnotationAsync(GetAnnotationRequest request, CallOptions options)Reads annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAnnotation |
The call object. |
GetAnnotationAsync(GetAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Annotation> GetAnnotationAsync(GetAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Reads annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAnnotation |
The call object. |
GetAsset(GetAssetRequest, CallOptions)
public virtual Asset GetAsset(GetAssetRequest request, CallOptions options)Reads an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Asset |
The response received from the server. |
GetAsset(GetAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Asset GetAsset(GetAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Reads an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Asset |
The response received from the server. |
GetAssetAsync(GetAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Asset> GetAssetAsync(GetAssetRequest request, CallOptions options)Reads an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAsset |
The call object. |
GetAssetAsync(GetAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Asset> GetAssetAsync(GetAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Reads an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAsset |
The call object. |
GetCollection(GetCollectionRequest, CallOptions)
public virtual Collection GetCollection(GetCollectionRequest request, CallOptions options)Gets a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Collection |
The response received from the server. |
GetCollection(GetCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual Collection GetCollection(GetCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Collection |
The response received from the server. |
GetCollectionAsync(GetCollectionRequest, CallOptions)
public virtual AsyncUnaryCall<Collection> GetCollectionAsync(GetCollectionRequest request, CallOptions options)Gets a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCollection |
The call object. |
GetCollectionAsync(GetCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Collection> GetCollectionAsync(GetCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCollection |
The call object. |
GetCorpus(GetCorpusRequest, CallOptions)
public virtual Corpus GetCorpus(GetCorpusRequest request, CallOptions options)Gets corpus details inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Corpus |
The response received from the server. |
GetCorpus(GetCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual Corpus GetCorpus(GetCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets corpus details inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Corpus |
The response received from the server. |
GetCorpusAsync(GetCorpusRequest, CallOptions)
public virtual AsyncUnaryCall<Corpus> GetCorpusAsync(GetCorpusRequest request, CallOptions options)Gets corpus details inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCorpus |
The call object. |
GetCorpusAsync(GetCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Corpus> GetCorpusAsync(GetCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets corpus details inside a project.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCorpus |
The call object. |
GetDataSchema(GetDataSchemaRequest, CallOptions)
public virtual DataSchema GetDataSchema(GetDataSchemaRequest request, CallOptions options)Gets data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
DataSchema |
The response received from the server. |
GetDataSchema(GetDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual DataSchema GetDataSchema(GetDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
DataSchema |
The response received from the server. |
GetDataSchemaAsync(GetDataSchemaRequest, CallOptions)
public virtual AsyncUnaryCall<DataSchema> GetDataSchemaAsync(GetDataSchemaRequest request, CallOptions options)Gets data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDataSchema |
The call object. |
GetDataSchemaAsync(GetDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DataSchema> GetDataSchemaAsync(GetDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDataSchema |
The call object. |
GetIndex(GetIndexRequest, CallOptions)
public virtual Index GetIndex(GetIndexRequest request, CallOptions options)Gets the details of a single Index under a Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Index |
The response received from the server. |
GetIndex(GetIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual Index GetIndex(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a single Index under a Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Index |
The response received from the server. |
GetIndexAsync(GetIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, CallOptions options)Gets the details of a single Index under a Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallIndex |
The call object. |
GetIndexAsync(GetIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a single Index under a Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallIndex |
The call object. |
GetIndexEndpoint(GetIndexEndpointRequest, CallOptions)
public virtual IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, CallOptions options)Gets an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
IndexEndpoint |
The response received from the server. |
GetIndexEndpoint(GetIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
IndexEndpoint |
The response received from the server. |
GetIndexEndpointAsync(GetIndexEndpointRequest, CallOptions)
public virtual AsyncUnaryCall<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, CallOptions options)Gets an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallIndexEndpoint |
The call object. |
GetIndexEndpointAsync(GetIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallIndexEndpoint |
The call object. |
GetSearchConfig(GetSearchConfigRequest, CallOptions)
public virtual SearchConfig GetSearchConfig(GetSearchConfigRequest request, CallOptions options)Gets a search configuration inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchConfig |
The response received from the server. |
GetSearchConfig(GetSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchConfig GetSearchConfig(GetSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a search configuration inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchConfig |
The response received from the server. |
GetSearchConfigAsync(GetSearchConfigRequest, CallOptions)
public virtual AsyncUnaryCall<SearchConfig> GetSearchConfigAsync(GetSearchConfigRequest request, CallOptions options)Gets a search configuration inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchConfig |
The call object. |
GetSearchConfigAsync(GetSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchConfig> GetSearchConfigAsync(GetSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a search configuration inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchConfig |
The call object. |
GetSearchHypernym(GetSearchHypernymRequest, CallOptions)
public virtual SearchHypernym GetSearchHypernym(GetSearchHypernymRequest request, CallOptions options)Gets a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchHypernym |
The response received from the server. |
GetSearchHypernym(GetSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchHypernym GetSearchHypernym(GetSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchHypernym |
The response received from the server. |
GetSearchHypernymAsync(GetSearchHypernymRequest, CallOptions)
public virtual AsyncUnaryCall<SearchHypernym> GetSearchHypernymAsync(GetSearchHypernymRequest request, CallOptions options)Gets a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchHypernym |
The call object. |
GetSearchHypernymAsync(GetSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchHypernym> GetSearchHypernymAsync(GetSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchHypernym |
The call object. |
ImportAssets(ImportAssetsRequest, CallOptions)
public virtual Operation ImportAssets(ImportAssetsRequest request, CallOptions options)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 |
ImportAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ImportAssets(ImportAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ImportAssets(ImportAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
ImportAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ImportAssetsAsync(ImportAssetsRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ImportAssetsAsync(ImportAssetsRequest request, CallOptions options)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 |
ImportAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ImportAssetsAsync(ImportAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ImportAssetsAsync(ImportAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
ImportAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
IndexAsset(IndexAssetRequest, CallOptions)
public virtual Operation IndexAsset(IndexAssetRequest request, CallOptions options)Index one asset for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
IndexAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
IndexAsset(IndexAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation IndexAsset(IndexAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Index one asset for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
IndexAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
IndexAssetAsync(IndexAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> IndexAssetAsync(IndexAssetRequest request, CallOptions options)Index one asset for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
IndexAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
IndexAssetAsync(IndexAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> IndexAssetAsync(IndexAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Index one asset for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
IndexAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
IngestAsset(CallOptions)
public virtual AsyncDuplexStreamingCall<IngestAssetRequest, IngestAssetResponse> IngestAsset(CallOptions options)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).
| Parameter | |
|---|---|
| Name | Description |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncDuplexStreamingCallIngestAssetRequestIngestAssetResponse |
The call object. |
IngestAsset(Metadata, DateTime?, CancellationToken)
public virtual AsyncDuplexStreamingCall<IngestAssetRequest, IngestAssetResponse> IngestAsset(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncDuplexStreamingCallIngestAssetRequestIngestAssetResponse |
The call object. |
ListAnnotations(ListAnnotationsRequest, CallOptions)
public virtual ListAnnotationsResponse ListAnnotations(ListAnnotationsRequest request, CallOptions options)Lists a list of annotations inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAnnotationsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsResponse |
The response received from the server. |
ListAnnotations(ListAnnotationsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListAnnotationsResponse ListAnnotations(ListAnnotationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists a list of annotations inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAnnotationsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsResponse |
The response received from the server. |
ListAnnotationsAsync(ListAnnotationsRequest, CallOptions)
public virtual AsyncUnaryCall<ListAnnotationsResponse> ListAnnotationsAsync(ListAnnotationsRequest request, CallOptions options)Lists a list of annotations inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAnnotationsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAnnotationsResponse |
The call object. |
ListAnnotationsAsync(ListAnnotationsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListAnnotationsResponse> ListAnnotationsAsync(ListAnnotationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists a list of annotations inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAnnotationsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAnnotationsResponse |
The call object. |
ListAssets(ListAssetsRequest, CallOptions)
public virtual ListAssetsResponse ListAssets(ListAssetsRequest request, CallOptions options)Lists an list of assets inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListAssetsResponse |
The response received from the server. |
ListAssets(ListAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListAssetsResponse ListAssets(ListAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists an list of assets inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListAssetsResponse |
The response received from the server. |
ListAssetsAsync(ListAssetsRequest, CallOptions)
public virtual AsyncUnaryCall<ListAssetsResponse> ListAssetsAsync(ListAssetsRequest request, CallOptions options)Lists an list of assets inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAssetsResponse |
The call object. |
ListAssetsAsync(ListAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListAssetsResponse> ListAssetsAsync(ListAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists an list of assets inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAssetsResponse |
The call object. |
ListCollections(ListCollectionsRequest, CallOptions)
public virtual ListCollectionsResponse ListCollections(ListCollectionsRequest request, CallOptions options)Lists collections inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCollectionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListCollectionsResponse |
The response received from the server. |
ListCollections(ListCollectionsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListCollectionsResponse ListCollections(ListCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists collections inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCollectionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListCollectionsResponse |
The response received from the server. |
ListCollectionsAsync(ListCollectionsRequest, CallOptions)
public virtual AsyncUnaryCall<ListCollectionsResponse> ListCollectionsAsync(ListCollectionsRequest request, CallOptions options)Lists collections inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCollectionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListCollectionsResponse |
The call object. |
ListCollectionsAsync(ListCollectionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListCollectionsResponse> ListCollectionsAsync(ListCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists collections inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCollectionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListCollectionsResponse |
The call object. |
ListCorpora(ListCorporaRequest, CallOptions)
public virtual ListCorporaResponse ListCorpora(ListCorporaRequest request, CallOptions options)Lists all corpora in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCorporaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListCorporaResponse |
The response received from the server. |
ListCorpora(ListCorporaRequest, Metadata, DateTime?, CancellationToken)
public virtual ListCorporaResponse ListCorpora(ListCorporaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all corpora in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCorporaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListCorporaResponse |
The response received from the server. |
ListCorporaAsync(ListCorporaRequest, CallOptions)
public virtual AsyncUnaryCall<ListCorporaResponse> ListCorporaAsync(ListCorporaRequest request, CallOptions options)Lists all corpora in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCorporaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListCorporaResponse |
The call object. |
ListCorporaAsync(ListCorporaRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListCorporaResponse> ListCorporaAsync(ListCorporaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all corpora in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListCorporaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListCorporaResponse |
The call object. |
ListDataSchemas(ListDataSchemasRequest, CallOptions)
public virtual ListDataSchemasResponse ListDataSchemas(ListDataSchemasRequest request, CallOptions options)Lists a list of data schemas inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListDataSchemasRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListDataSchemasResponse |
The response received from the server. |
ListDataSchemas(ListDataSchemasRequest, Metadata, DateTime?, CancellationToken)
public virtual ListDataSchemasResponse ListDataSchemas(ListDataSchemasRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists a list of data schemas inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListDataSchemasRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListDataSchemasResponse |
The response received from the server. |
ListDataSchemasAsync(ListDataSchemasRequest, CallOptions)
public virtual AsyncUnaryCall<ListDataSchemasResponse> ListDataSchemasAsync(ListDataSchemasRequest request, CallOptions options)Lists a list of data schemas inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListDataSchemasRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListDataSchemasResponse |
The call object. |
ListDataSchemasAsync(ListDataSchemasRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListDataSchemasResponse> ListDataSchemasAsync(ListDataSchemasRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists a list of data schemas inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListDataSchemasRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListDataSchemasResponse |
The call object. |
ListIndexEndpoints(ListIndexEndpointsRequest, CallOptions)
public virtual ListIndexEndpointsResponse ListIndexEndpoints(ListIndexEndpointsRequest request, CallOptions options)Lists all IndexEndpoints in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexEndpointsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsResponse |
The response received from the server. |
ListIndexEndpoints(ListIndexEndpointsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListIndexEndpointsResponse ListIndexEndpoints(ListIndexEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all IndexEndpoints in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexEndpointsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsResponse |
The response received from the server. |
ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallOptions)
public virtual AsyncUnaryCall<ListIndexEndpointsResponse> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, CallOptions options)Lists all IndexEndpoints in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexEndpointsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListIndexEndpointsResponse |
The call object. |
ListIndexEndpointsAsync(ListIndexEndpointsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListIndexEndpointsResponse> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all IndexEndpoints in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexEndpointsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListIndexEndpointsResponse |
The call object. |
ListIndexes(ListIndexesRequest, CallOptions)
public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, CallOptions options)List all Indexes in a given Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListIndexesResponse |
The response received from the server. |
ListIndexes(ListIndexesRequest, Metadata, DateTime?, CancellationToken)
public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)List all Indexes in a given Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListIndexesResponse |
The response received from the server. |
ListIndexesAsync(ListIndexesRequest, CallOptions)
public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, CallOptions options)List all Indexes in a given Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListIndexesResponse |
The call object. |
ListIndexesAsync(ListIndexesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)List all Indexes in a given Corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListIndexesResponse |
The call object. |
ListSearchConfigs(ListSearchConfigsRequest, CallOptions)
public virtual ListSearchConfigsResponse ListSearchConfigs(ListSearchConfigsRequest request, CallOptions options)Lists all search configurations inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchConfigsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListSearchConfigsResponse |
The response received from the server. |
ListSearchConfigs(ListSearchConfigsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListSearchConfigsResponse ListSearchConfigs(ListSearchConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all search configurations inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchConfigsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListSearchConfigsResponse |
The response received from the server. |
ListSearchConfigsAsync(ListSearchConfigsRequest, CallOptions)
public virtual AsyncUnaryCall<ListSearchConfigsResponse> ListSearchConfigsAsync(ListSearchConfigsRequest request, CallOptions options)Lists all search configurations inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchConfigsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListSearchConfigsResponse |
The call object. |
ListSearchConfigsAsync(ListSearchConfigsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListSearchConfigsResponse> ListSearchConfigsAsync(ListSearchConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all search configurations inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchConfigsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListSearchConfigsResponse |
The call object. |
ListSearchHypernyms(ListSearchHypernymsRequest, CallOptions)
public virtual ListSearchHypernymsResponse ListSearchHypernyms(ListSearchHypernymsRequest request, CallOptions options)Lists SearchHypernyms inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchHypernymsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListSearchHypernymsResponse |
The response received from the server. |
ListSearchHypernyms(ListSearchHypernymsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListSearchHypernymsResponse ListSearchHypernyms(ListSearchHypernymsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists SearchHypernyms inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchHypernymsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListSearchHypernymsResponse |
The response received from the server. |
ListSearchHypernymsAsync(ListSearchHypernymsRequest, CallOptions)
public virtual AsyncUnaryCall<ListSearchHypernymsResponse> ListSearchHypernymsAsync(ListSearchHypernymsRequest request, CallOptions options)Lists SearchHypernyms inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchHypernymsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListSearchHypernymsResponse |
The call object. |
ListSearchHypernymsAsync(ListSearchHypernymsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListSearchHypernymsResponse> ListSearchHypernymsAsync(ListSearchHypernymsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists SearchHypernyms inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSearchHypernymsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListSearchHypernymsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override Warehouse.WarehouseClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
WarehouseWarehouseClient |
|
RemoveCollectionItem(RemoveCollectionItemRequest, CallOptions)
public virtual RemoveCollectionItemResponse RemoveCollectionItem(RemoveCollectionItemRequest request, CallOptions options)Removes an item from a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveCollectionItemRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
RemoveCollectionItemResponse |
The response received from the server. |
RemoveCollectionItem(RemoveCollectionItemRequest, Metadata, DateTime?, CancellationToken)
public virtual RemoveCollectionItemResponse RemoveCollectionItem(RemoveCollectionItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Removes an item from a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveCollectionItemRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
RemoveCollectionItemResponse |
The response received from the server. |
RemoveCollectionItemAsync(RemoveCollectionItemRequest, CallOptions)
public virtual AsyncUnaryCall<RemoveCollectionItemResponse> RemoveCollectionItemAsync(RemoveCollectionItemRequest request, CallOptions options)Removes an item from a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveCollectionItemRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRemoveCollectionItemResponse |
The call object. |
RemoveCollectionItemAsync(RemoveCollectionItemRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<RemoveCollectionItemResponse> RemoveCollectionItemAsync(RemoveCollectionItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Removes an item from a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveCollectionItemRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRemoveCollectionItemResponse |
The call object. |
RemoveIndexAsset(RemoveIndexAssetRequest, CallOptions)
public virtual Operation RemoveIndexAsset(RemoveIndexAssetRequest request, CallOptions options)Remove one asset's index data for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveIndexAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
RemoveIndexAsset(RemoveIndexAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation RemoveIndexAsset(RemoveIndexAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Remove one asset's index data for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveIndexAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
RemoveIndexAssetAsync(RemoveIndexAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> RemoveIndexAssetAsync(RemoveIndexAssetRequest request, CallOptions options)Remove one asset's index data for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveIndexAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
RemoveIndexAssetAsync(RemoveIndexAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> RemoveIndexAssetAsync(RemoveIndexAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Remove one asset's index data for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveIndexAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
SearchAssets(SearchAssetsRequest, CallOptions)
public virtual SearchAssetsResponse SearchAssets(SearchAssetsRequest request, CallOptions options)Search media asset.
| Parameters | |
|---|---|
| Name | Description |
request |
SearchAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchAssetsResponse |
The response received from the server. |
SearchAssets(SearchAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchAssetsResponse SearchAssets(SearchAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Search media asset.
| Parameters | |
|---|---|
| Name | Description |
request |
SearchAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchAssetsResponse |
The response received from the server. |
SearchAssetsAsync(SearchAssetsRequest, CallOptions)
public virtual AsyncUnaryCall<SearchAssetsResponse> SearchAssetsAsync(SearchAssetsRequest request, CallOptions options)Search media asset.
| Parameters | |
|---|---|
| Name | Description |
request |
SearchAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchAssetsResponse |
The call object. |
SearchAssetsAsync(SearchAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchAssetsResponse> SearchAssetsAsync(SearchAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Search media asset.
| Parameters | |
|---|---|
| Name | Description |
request |
SearchAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchAssetsResponse |
The call object. |
SearchIndexEndpoint(SearchIndexEndpointRequest, CallOptions)
public virtual SearchIndexEndpointResponse SearchIndexEndpoint(SearchIndexEndpointRequest request, CallOptions options)Search a deployed index endpoint (IMAGE corpus type only).
| Parameters | |
|---|---|
| Name | Description |
request |
SearchIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchIndexEndpointResponse |
The response received from the server. |
SearchIndexEndpoint(SearchIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchIndexEndpointResponse SearchIndexEndpoint(SearchIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Search a deployed index endpoint (IMAGE corpus type only).
| Parameters | |
|---|---|
| Name | Description |
request |
SearchIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchIndexEndpointResponse |
The response received from the server. |
SearchIndexEndpointAsync(SearchIndexEndpointRequest, CallOptions)
public virtual AsyncUnaryCall<SearchIndexEndpointResponse> SearchIndexEndpointAsync(SearchIndexEndpointRequest request, CallOptions options)Search a deployed index endpoint (IMAGE corpus type only).
| Parameters | |
|---|---|
| Name | Description |
request |
SearchIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchIndexEndpointResponse |
The call object. |
SearchIndexEndpointAsync(SearchIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchIndexEndpointResponse> SearchIndexEndpointAsync(SearchIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Search a deployed index endpoint (IMAGE corpus type only).
| Parameters | |
|---|---|
| Name | Description |
request |
SearchIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchIndexEndpointResponse |
The call object. |
UndeployIndex(UndeployIndexRequest, CallOptions)
public virtual Operation UndeployIndex(UndeployIndexRequest request, CallOptions options)Undeploys an Index from IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UndeployIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UndeployIndex(UndeployIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UndeployIndex(UndeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Undeploys an Index from IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UndeployIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UndeployIndexAsync(UndeployIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UndeployIndexAsync(UndeployIndexRequest request, CallOptions options)Undeploys an Index from IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UndeployIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UndeployIndexAsync(UndeployIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UndeployIndexAsync(UndeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Undeploys an Index from IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UndeployIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateAnnotation(UpdateAnnotationRequest, CallOptions)
public virtual Annotation UpdateAnnotation(UpdateAnnotationRequest request, CallOptions options)Updates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Annotation |
The response received from the server. |
UpdateAnnotation(UpdateAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual Annotation UpdateAnnotation(UpdateAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Annotation |
The response received from the server. |
UpdateAnnotationAsync(UpdateAnnotationRequest, CallOptions)
public virtual AsyncUnaryCall<Annotation> UpdateAnnotationAsync(UpdateAnnotationRequest request, CallOptions options)Updates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAnnotationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAnnotation |
The call object. |
UpdateAnnotationAsync(UpdateAnnotationRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Annotation> UpdateAnnotationAsync(UpdateAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates annotation inside asset.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAnnotationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAnnotation |
The call object. |
UpdateAsset(UpdateAssetRequest, CallOptions)
public virtual Asset UpdateAsset(UpdateAssetRequest request, CallOptions options)Updates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Asset |
The response received from the server. |
UpdateAsset(UpdateAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Asset UpdateAsset(UpdateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Asset |
The response received from the server. |
UpdateAssetAsync(UpdateAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Asset> UpdateAssetAsync(UpdateAssetRequest request, CallOptions options)Updates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAsset |
The call object. |
UpdateAssetAsync(UpdateAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Asset> UpdateAssetAsync(UpdateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates an asset inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAsset |
The call object. |
UpdateCollection(UpdateCollectionRequest, CallOptions)
public virtual Collection UpdateCollection(UpdateCollectionRequest request, CallOptions options)Updates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Collection |
The response received from the server. |
UpdateCollection(UpdateCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual Collection UpdateCollection(UpdateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Collection |
The response received from the server. |
UpdateCollectionAsync(UpdateCollectionRequest, CallOptions)
public virtual AsyncUnaryCall<Collection> UpdateCollectionAsync(UpdateCollectionRequest request, CallOptions options)Updates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCollection |
The call object. |
UpdateCollectionAsync(UpdateCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Collection> UpdateCollectionAsync(UpdateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCollection |
The call object. |
UpdateCorpus(UpdateCorpusRequest, CallOptions)
public virtual Corpus UpdateCorpus(UpdateCorpusRequest request, CallOptions options)Updates a corpus in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Corpus |
The response received from the server. |
UpdateCorpus(UpdateCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual Corpus UpdateCorpus(UpdateCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a corpus in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Corpus |
The response received from the server. |
UpdateCorpusAsync(UpdateCorpusRequest, CallOptions)
public virtual AsyncUnaryCall<Corpus> UpdateCorpusAsync(UpdateCorpusRequest request, CallOptions options)Updates a corpus in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCorpusRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCorpus |
The call object. |
UpdateCorpusAsync(UpdateCorpusRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Corpus> UpdateCorpusAsync(UpdateCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a corpus in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateCorpusRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCorpus |
The call object. |
UpdateDataSchema(UpdateDataSchemaRequest, CallOptions)
public virtual DataSchema UpdateDataSchema(UpdateDataSchemaRequest request, CallOptions options)Updates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
DataSchema |
The response received from the server. |
UpdateDataSchema(UpdateDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual DataSchema UpdateDataSchema(UpdateDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
DataSchema |
The response received from the server. |
UpdateDataSchemaAsync(UpdateDataSchemaRequest, CallOptions)
public virtual AsyncUnaryCall<DataSchema> UpdateDataSchemaAsync(UpdateDataSchemaRequest request, CallOptions options)Updates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateDataSchemaRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDataSchema |
The call object. |
UpdateDataSchemaAsync(UpdateDataSchemaRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DataSchema> UpdateDataSchemaAsync(UpdateDataSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates data schema inside corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateDataSchemaRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDataSchema |
The call object. |
UpdateIndex(UpdateIndexRequest, CallOptions)
public virtual Operation UpdateIndex(UpdateIndexRequest request, CallOptions options)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 |
UpdateIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateIndex(UpdateIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateIndex(UpdateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
UpdateIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateIndexAsync(UpdateIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateIndexAsync(UpdateIndexRequest request, CallOptions options)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 |
UpdateIndexRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateIndexAsync(UpdateIndexRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateIndexAsync(UpdateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
UpdateIndexRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallOptions)
public virtual Operation UpdateIndexEndpoint(UpdateIndexEndpointRequest request, CallOptions options)Updates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateIndexEndpoint(UpdateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateIndexEndpoint(UpdateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, CallOptions options)Updates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateIndexEndpointRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateIndexEndpointRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateSearchConfig(UpdateSearchConfigRequest, CallOptions)
public virtual SearchConfig UpdateSearchConfig(UpdateSearchConfigRequest request, CallOptions options)Updates a search configuration inside a corpus.
Please follow the rules below to create a valid UpdateSearchConfigRequest. --- General Rules ---
- Request.search_configuration.name must already exist.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
UpdateSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchConfig |
The response received from the server. |
UpdateSearchConfig(UpdateSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchConfig UpdateSearchConfig(UpdateSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a search configuration inside a corpus.
Please follow the rules below to create a valid UpdateSearchConfigRequest. --- General Rules ---
- Request.search_configuration.name must already exist.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
UpdateSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchConfig |
The response received from the server. |
UpdateSearchConfigAsync(UpdateSearchConfigRequest, CallOptions)
public virtual AsyncUnaryCall<SearchConfig> UpdateSearchConfigAsync(UpdateSearchConfigRequest request, CallOptions options)Updates a search configuration inside a corpus.
Please follow the rules below to create a valid UpdateSearchConfigRequest. --- General Rules ---
- Request.search_configuration.name must already exist.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
UpdateSearchConfigRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchConfig |
The call object. |
UpdateSearchConfigAsync(UpdateSearchConfigRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchConfig> UpdateSearchConfigAsync(UpdateSearchConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a search configuration inside a corpus.
Please follow the rules below to create a valid UpdateSearchConfigRequest. --- General Rules ---
- Request.search_configuration.name must already exist.
- Request must contain at least one non-empty search_criteria_property or facet_property.
- mapped_fields must not be empty, and must map to existing UGA keys.
- All mapped_fields must be of the same type.
- All mapped_fields must share the same granularity.
- 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 |
UpdateSearchConfigRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchConfig |
The call object. |
UpdateSearchHypernym(UpdateSearchHypernymRequest, CallOptions)
public virtual SearchHypernym UpdateSearchHypernym(UpdateSearchHypernymRequest request, CallOptions options)Updates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SearchHypernym |
The response received from the server. |
UpdateSearchHypernym(UpdateSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchHypernym UpdateSearchHypernym(UpdateSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SearchHypernym |
The response received from the server. |
UpdateSearchHypernymAsync(UpdateSearchHypernymRequest, CallOptions)
public virtual AsyncUnaryCall<SearchHypernym> UpdateSearchHypernymAsync(UpdateSearchHypernymRequest request, CallOptions options)Updates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSearchHypernymRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchHypernym |
The call object. |
UpdateSearchHypernymAsync(UpdateSearchHypernymRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchHypernym> UpdateSearchHypernymAsync(UpdateSearchHypernymRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates a SearchHypernym inside a corpus.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSearchHypernymRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSearchHypernym |
The call object. |
UploadAsset(UploadAssetRequest, CallOptions)
public virtual Operation UploadAsset(UploadAssetRequest request, CallOptions options)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 |
UploadAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UploadAsset(UploadAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UploadAsset(UploadAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
UploadAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UploadAssetAsync(UploadAssetRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UploadAssetAsync(UploadAssetRequest request, CallOptions options)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 |
UploadAssetRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UploadAssetAsync(UploadAssetRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UploadAssetAsync(UploadAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
UploadAssetRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ViewCollectionItems(ViewCollectionItemsRequest, CallOptions)
public virtual ViewCollectionItemsResponse ViewCollectionItems(ViewCollectionItemsRequest request, CallOptions options)View items inside a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewCollectionItemsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ViewCollectionItemsResponse |
The response received from the server. |
ViewCollectionItems(ViewCollectionItemsRequest, Metadata, DateTime?, CancellationToken)
public virtual ViewCollectionItemsResponse ViewCollectionItems(ViewCollectionItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)View items inside a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewCollectionItemsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ViewCollectionItemsResponse |
The response received from the server. |
ViewCollectionItemsAsync(ViewCollectionItemsRequest, CallOptions)
public virtual AsyncUnaryCall<ViewCollectionItemsResponse> ViewCollectionItemsAsync(ViewCollectionItemsRequest request, CallOptions options)View items inside a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewCollectionItemsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallViewCollectionItemsResponse |
The call object. |
ViewCollectionItemsAsync(ViewCollectionItemsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ViewCollectionItemsResponse> ViewCollectionItemsAsync(ViewCollectionItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)View items inside a collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewCollectionItemsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallViewCollectionItemsResponse |
The call object. |
ViewIndexedAssets(ViewIndexedAssetsRequest, CallOptions)
public virtual ViewIndexedAssetsResponse ViewIndexedAssets(ViewIndexedAssetsRequest request, CallOptions options)Lists assets inside an index.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewIndexedAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ViewIndexedAssetsResponse |
The response received from the server. |
ViewIndexedAssets(ViewIndexedAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual ViewIndexedAssetsResponse ViewIndexedAssets(ViewIndexedAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists assets inside an index.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewIndexedAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ViewIndexedAssetsResponse |
The response received from the server. |
ViewIndexedAssetsAsync(ViewIndexedAssetsRequest, CallOptions)
public virtual AsyncUnaryCall<ViewIndexedAssetsResponse> ViewIndexedAssetsAsync(ViewIndexedAssetsRequest request, CallOptions options)Lists assets inside an index.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewIndexedAssetsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallViewIndexedAssetsResponse |
The call object. |
ViewIndexedAssetsAsync(ViewIndexedAssetsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ViewIndexedAssetsResponse> ViewIndexedAssetsAsync(ViewIndexedAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists assets inside an index.
| Parameters | |
|---|---|
| Name | Description |
request |
ViewIndexedAssetsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallViewIndexedAssetsResponse |
The call object. |