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

public sealed class LiveVideoAnalyticsClientImpl : LiveVideoAnalyticsClient

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

LiveVideoAnalytics client wrapper implementation, for convenient use.

Inheritance

object > LiveVideoAnalyticsClient > LiveVideoAnalyticsClientImpl

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Remarks

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

Constructors

LiveVideoAnalyticsClientImpl(LiveVideoAnalyticsClient, LiveVideoAnalyticsSettings, ILogger)

public LiveVideoAnalyticsClientImpl(LiveVideoAnalytics.LiveVideoAnalyticsClient grpcClient, LiveVideoAnalyticsSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient LiveVideoAnalyticsLiveVideoAnalyticsClient

The underlying gRPC client.

settings LiveVideoAnalyticsSettings

The base LiveVideoAnalyticsSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

BatchRunProcessOperationsClient

public override OperationsClient BatchRunProcessOperationsClient { get; }

The long-running operations client for BatchRunProcess.

Property Value
Type Description
OperationsClient
Overrides

CreateAnalysisOperationsClient

public override OperationsClient CreateAnalysisOperationsClient { get; }

The long-running operations client for CreateAnalysis.

Property Value
Type Description
OperationsClient
Overrides

CreateOperatorOperationsClient

public override OperationsClient CreateOperatorOperationsClient { get; }

The long-running operations client for CreateOperator.

Property Value
Type Description
OperationsClient
Overrides

CreateProcessOperationsClient

public override OperationsClient CreateProcessOperationsClient { get; }

The long-running operations client for CreateProcess.

Property Value
Type Description
OperationsClient
Overrides

DeleteAnalysisOperationsClient

public override OperationsClient DeleteAnalysisOperationsClient { get; }

The long-running operations client for DeleteAnalysis.

Property Value
Type Description
OperationsClient
Overrides

DeleteOperatorOperationsClient

public override OperationsClient DeleteOperatorOperationsClient { get; }

The long-running operations client for DeleteOperator.

Property Value
Type Description
OperationsClient
Overrides

DeleteProcessOperationsClient

public override OperationsClient DeleteProcessOperationsClient { get; }

The long-running operations client for DeleteProcess.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override LiveVideoAnalytics.LiveVideoAnalyticsClient GrpcClient { get; }

The underlying gRPC LiveVideoAnalytics client

Property Value
Type Description
LiveVideoAnalyticsLiveVideoAnalyticsClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateAnalysisOperationsClient

public override OperationsClient UpdateAnalysisOperationsClient { get; }

The long-running operations client for UpdateAnalysis.

Property Value
Type Description
OperationsClient
Overrides

UpdateOperatorOperationsClient

public override OperationsClient UpdateOperatorOperationsClient { get; }

The long-running operations client for UpdateOperator.

Property Value
Type Description
OperationsClient
Overrides

UpdateProcessOperationsClient

public override OperationsClient UpdateProcessOperationsClient { get; }

The long-running operations client for UpdateProcess.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchRunProcess(BatchRunProcessRequest, CallSettings)

public override Operation<BatchRunProcessResponse, OperationMetadata> BatchRunProcess(BatchRunProcessRequest request, CallSettings callSettings = null)

Run all of the processes to "completion". Max time for each process is the LRO time limit.

Parameters
Name Description
request BatchRunProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBatchRunProcessResponseOperationMetadata

The RPC response.

Overrides

BatchRunProcessAsync(BatchRunProcessRequest, CallSettings)

public override Task<Operation<BatchRunProcessResponse, OperationMetadata>> BatchRunProcessAsync(BatchRunProcessRequest request, CallSettings callSettings = null)

Run all of the processes to "completion". Max time for each process is the LRO time limit.

Parameters
Name Description
request BatchRunProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBatchRunProcessResponseOperationMetadata

A Task containing the RPC response.

Overrides

CreateAnalysis(CreateAnalysisRequest, CallSettings)

public override Operation<Analysis, OperationMetadata> CreateAnalysis(CreateAnalysisRequest request, CallSettings callSettings = null)

Creates a new Analysis in a given project and location.

Parameters
Name Description
request CreateAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnalysisOperationMetadata

The RPC response.

Overrides

CreateAnalysisAsync(CreateAnalysisRequest, CallSettings)

public override Task<Operation<Analysis, OperationMetadata>> CreateAnalysisAsync(CreateAnalysisRequest request, CallSettings callSettings = null)

Creates a new Analysis in a given project and location.

Parameters
Name Description
request CreateAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnalysisOperationMetadata

A Task containing the RPC response.

Overrides

CreateOperator(CreateOperatorRequest, CallSettings)

public override Operation<Operator, OperationMetadata> CreateOperator(CreateOperatorRequest request, CallSettings callSettings = null)

Creates a new Operator in a given project and location.

Parameters
Name Description
request CreateOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperatorOperationMetadata

The RPC response.

Overrides

CreateOperatorAsync(CreateOperatorRequest, CallSettings)

public override Task<Operation<Operator, OperationMetadata>> CreateOperatorAsync(CreateOperatorRequest request, CallSettings callSettings = null)

Creates a new Operator in a given project and location.

Parameters
Name Description
request CreateOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperatorOperationMetadata

A Task containing the RPC response.

Overrides

CreateProcess(CreateProcessRequest, CallSettings)

public override Operation<Process, OperationMetadata> CreateProcess(CreateProcessRequest request, CallSettings callSettings = null)

Creates a new Process in a given project and location.

Parameters
Name Description
request CreateProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationProcessOperationMetadata

The RPC response.

Overrides

CreateProcessAsync(CreateProcessRequest, CallSettings)

public override Task<Operation<Process, OperationMetadata>> CreateProcessAsync(CreateProcessRequest request, CallSettings callSettings = null)

Creates a new Process in a given project and location.

Parameters
Name Description
request CreateProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationProcessOperationMetadata

A Task containing the RPC response.

Overrides

DeleteAnalysis(DeleteAnalysisRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteAnalysis(DeleteAnalysisRequest request, CallSettings callSettings = null)

Deletes a single Analysis.

Parameters
Name Description
request DeleteAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteAnalysisAsync(DeleteAnalysisRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteAnalysisAsync(DeleteAnalysisRequest request, CallSettings callSettings = null)

Deletes a single Analysis.

Parameters
Name Description
request DeleteAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DeleteOperator(DeleteOperatorRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteOperator(DeleteOperatorRequest request, CallSettings callSettings = null)

Deletes a single Operator.

Parameters
Name Description
request DeleteOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteOperatorAsync(DeleteOperatorRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteOperatorAsync(DeleteOperatorRequest request, CallSettings callSettings = null)

Deletes a single Operator.

Parameters
Name Description
request DeleteOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DeleteProcess(DeleteProcessRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteProcess(DeleteProcessRequest request, CallSettings callSettings = null)

Deletes a single Process.

Parameters
Name Description
request DeleteProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteProcessAsync(DeleteProcessRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteProcessAsync(DeleteProcessRequest request, CallSettings callSettings = null)

Deletes a single Process.

Parameters
Name Description
request DeleteProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

GetAnalysis(GetAnalysisRequest, CallSettings)

public override Analysis GetAnalysis(GetAnalysisRequest request, CallSettings callSettings = null)

Gets details of a single Analysis.

Parameters
Name Description
request GetAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Analysis

The RPC response.

Overrides

GetAnalysisAsync(GetAnalysisRequest, CallSettings)

public override Task<Analysis> GetAnalysisAsync(GetAnalysisRequest request, CallSettings callSettings = null)

Gets details of a single Analysis.

Parameters
Name Description
request GetAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAnalysis

A Task containing the RPC response.

Overrides

GetOperator(GetOperatorRequest, CallSettings)

public override Operator GetOperator(GetOperatorRequest request, CallSettings callSettings = null)

Gets details of a single Operator.

Parameters
Name Description
request GetOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operator

The RPC response.

Overrides

GetOperatorAsync(GetOperatorRequest, CallSettings)

public override Task<Operator> GetOperatorAsync(GetOperatorRequest request, CallSettings callSettings = null)

Gets details of a single Operator.

Parameters
Name Description
request GetOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperator

A Task containing the RPC response.

Overrides

GetProcess(GetProcessRequest, CallSettings)

public override Process GetProcess(GetProcessRequest request, CallSettings callSettings = null)

Gets details of a single Process.

Parameters
Name Description
request GetProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Process

The RPC response.

Overrides

GetProcessAsync(GetProcessRequest, CallSettings)

public override Task<Process> GetProcessAsync(GetProcessRequest request, CallSettings callSettings = null)

Gets details of a single Process.

Parameters
Name Description
request GetProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskProcess

A Task containing the RPC response.

Overrides

ListAnalyses(ListAnalysesRequest, CallSettings)

public override PagedEnumerable<ListAnalysesResponse, Analysis> ListAnalyses(ListAnalysesRequest request, CallSettings callSettings = null)

Lists Analyses in a given project and location.

Parameters
Name Description
request ListAnalysesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAnalysesResponseAnalysis

A pageable sequence of Analysis resources.

Overrides

ListAnalysesAsync(ListAnalysesRequest, CallSettings)

public override PagedAsyncEnumerable<ListAnalysesResponse, Analysis> ListAnalysesAsync(ListAnalysesRequest request, CallSettings callSettings = null)

Lists Analyses in a given project and location.

Parameters
Name Description
request ListAnalysesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAnalysesResponseAnalysis

A pageable asynchronous sequence of Analysis resources.

Overrides

ListOperators(ListOperatorsRequest, CallSettings)

public override PagedEnumerable<ListOperatorsResponse, Operator> ListOperators(ListOperatorsRequest request, CallSettings callSettings = null)

Lists Operators in a given project and location.

Parameters
Name Description
request ListOperatorsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListOperatorsResponseOperator

A pageable sequence of Operator resources.

Overrides

ListOperatorsAsync(ListOperatorsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOperatorsResponse, Operator> ListOperatorsAsync(ListOperatorsRequest request, CallSettings callSettings = null)

Lists Operators in a given project and location.

Parameters
Name Description
request ListOperatorsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListOperatorsResponseOperator

A pageable asynchronous sequence of Operator resources.

Overrides

ListProcesses(ListProcessesRequest, CallSettings)

public override PagedEnumerable<ListProcessesResponse, Process> ListProcesses(ListProcessesRequest request, CallSettings callSettings = null)

Lists Processes in a given project and location.

Parameters
Name Description
request ListProcessesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListProcessesResponseProcess

A pageable sequence of Process resources.

Overrides

ListProcessesAsync(ListProcessesRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessesResponse, Process> ListProcessesAsync(ListProcessesRequest request, CallSettings callSettings = null)

Lists Processes in a given project and location.

Parameters
Name Description
request ListProcessesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListProcessesResponseProcess

A pageable asynchronous sequence of Process resources.

Overrides

ListPublicOperators(ListPublicOperatorsRequest, CallSettings)

public override PagedEnumerable<ListPublicOperatorsResponse, Operator> ListPublicOperators(ListPublicOperatorsRequest request, CallSettings callSettings = null)

ListPublicOperators returns all the operators in public registry.

Parameters
Name Description
request ListPublicOperatorsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListPublicOperatorsResponseOperator

A pageable sequence of Operator resources.

Overrides

ListPublicOperatorsAsync(ListPublicOperatorsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPublicOperatorsResponse, Operator> ListPublicOperatorsAsync(ListPublicOperatorsRequest request, CallSettings callSettings = null)

ListPublicOperators returns all the operators in public registry.

Parameters
Name Description
request ListPublicOperatorsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListPublicOperatorsResponseOperator

A pageable asynchronous sequence of Operator resources.

Overrides

ResolveOperatorInfo(ResolveOperatorInfoRequest, CallSettings)

public override ResolveOperatorInfoResponse ResolveOperatorInfo(ResolveOperatorInfoRequest request, CallSettings callSettings = null)

ResolveOperatorInfo returns the operator information based on the request.

Parameters
Name Description
request ResolveOperatorInfoRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ResolveOperatorInfoResponse

The RPC response.

Overrides

ResolveOperatorInfoAsync(ResolveOperatorInfoRequest, CallSettings)

public override Task<ResolveOperatorInfoResponse> ResolveOperatorInfoAsync(ResolveOperatorInfoRequest request, CallSettings callSettings = null)

ResolveOperatorInfo returns the operator information based on the request.

Parameters
Name Description
request ResolveOperatorInfoRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskResolveOperatorInfoResponse

A Task containing the RPC response.

Overrides

UpdateAnalysis(UpdateAnalysisRequest, CallSettings)

public override Operation<Analysis, OperationMetadata> UpdateAnalysis(UpdateAnalysisRequest request, CallSettings callSettings = null)

Updates the parameters of a single Analysis.

Parameters
Name Description
request UpdateAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnalysisOperationMetadata

The RPC response.

Overrides

UpdateAnalysisAsync(UpdateAnalysisRequest, CallSettings)

public override Task<Operation<Analysis, OperationMetadata>> UpdateAnalysisAsync(UpdateAnalysisRequest request, CallSettings callSettings = null)

Updates the parameters of a single Analysis.

Parameters
Name Description
request UpdateAnalysisRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnalysisOperationMetadata

A Task containing the RPC response.

Overrides

UpdateOperator(UpdateOperatorRequest, CallSettings)

public override Operation<Operator, OperationMetadata> UpdateOperator(UpdateOperatorRequest request, CallSettings callSettings = null)

Updates the parameters of a single Operator.

Parameters
Name Description
request UpdateOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperatorOperationMetadata

The RPC response.

Overrides

UpdateOperatorAsync(UpdateOperatorRequest, CallSettings)

public override Task<Operation<Operator, OperationMetadata>> UpdateOperatorAsync(UpdateOperatorRequest request, CallSettings callSettings = null)

Updates the parameters of a single Operator.

Parameters
Name Description
request UpdateOperatorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperatorOperationMetadata

A Task containing the RPC response.

Overrides

UpdateProcess(UpdateProcessRequest, CallSettings)

public override Operation<Process, OperationMetadata> UpdateProcess(UpdateProcessRequest request, CallSettings callSettings = null)

Updates the parameters of a single Process.

Parameters
Name Description
request UpdateProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationProcessOperationMetadata

The RPC response.

Overrides

UpdateProcessAsync(UpdateProcessRequest, CallSettings)

public override Task<Operation<Process, OperationMetadata>> UpdateProcessAsync(UpdateProcessRequest request, CallSettings callSettings = null)

Updates the parameters of a single Process.

Parameters
Name Description
request UpdateProcessRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationProcessOperationMetadata

A Task containing the RPC response.

Overrides