Show / Hide Table of Contents

Class AIServiceVisionClient

Service client instance for AIServiceVision.

Inheritance
object
ClientBase
RegionalClientBase
AIServiceVisionClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.AivisionService
Assembly: OCI.DotNetSDK.Aivision.dll
Syntax
public class AIServiceVisionClient : RegionalClientBase, IDisposable

Constructors

AIServiceVisionClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public AIServiceVisionClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.

ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.

string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public AIServiceVisionPaginators Paginators { get; }
Property Value
Type Description
AIServiceVisionPaginators

Waiters

Declaration
public AIServiceVisionWaiters Waiters { get; }
Property Value
Type Description
AIServiceVisionWaiters

Methods

AnalyzeDocument(AnalyzeDocumentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Perform different types of image analysis.

Declaration
public Task<AnalyzeDocumentResponse> AnalyzeDocument(AnalyzeDocumentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
AnalyzeDocumentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<AnalyzeDocumentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use AnalyzeDocument API.

AnalyzeImage(AnalyzeImageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Perform different types of image analysis.

Declaration
public Task<AnalyzeImageResponse> AnalyzeImage(AnalyzeImageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
AnalyzeImageRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<AnalyzeImageResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use AnalyzeImage API.

CancelDocumentJob(CancelDocumentJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel a document batch job.

Declaration
public Task<CancelDocumentJobResponse> CancelDocumentJob(CancelDocumentJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelDocumentJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CancelDocumentJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelDocumentJob API.

CancelImageJob(CancelImageJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel an image batch job.

Declaration
public Task<CancelImageJobResponse> CancelImageJob(CancelImageJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelImageJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CancelImageJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelImageJob API.

CancelVideoJob(CancelVideoJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel a video analysis job.

Declaration
public Task<CancelVideoJobResponse> CancelVideoJob(CancelVideoJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelVideoJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CancelVideoJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelVideoJob API.

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel the work request with the given ID.

Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelWorkRequestRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CancelWorkRequestResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelWorkRequest API.

ChangeModelCompartment(ChangeModelCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

Declaration
public Task<ChangeModelCompartmentResponse> ChangeModelCompartment(ChangeModelCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeModelCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeModelCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeModelCompartment API.

ChangeProjectCompartment(ChangeProjectCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

Declaration
public Task<ChangeProjectCompartmentResponse> ChangeProjectCompartment(ChangeProjectCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeProjectCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeProjectCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeProjectCompartment API.

ChangeStreamGroupCompartment(ChangeStreamGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Move a streamGroup from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

Declaration
public Task<ChangeStreamGroupCompartmentResponse> ChangeStreamGroupCompartment(ChangeStreamGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeStreamGroupCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeStreamGroupCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeStreamGroupCompartment API.

ChangeStreamJobCompartment(ChangeStreamJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Move a streamJob from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

Declaration
public Task<ChangeStreamJobCompartmentResponse> ChangeStreamJobCompartment(ChangeStreamJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeStreamJobCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeStreamJobCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeStreamJobCompartment API.

ChangeStreamSourceCompartment(ChangeStreamSourceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Move a streamSource from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

Declaration
public Task<ChangeStreamSourceCompartmentResponse> ChangeStreamSourceCompartment(ChangeStreamSourceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeStreamSourceCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeStreamSourceCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeStreamSourceCompartment API.

ChangeVisionPrivateEndpointCompartment(ChangeVisionPrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Move a visionPrivateEndpoint from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

Declaration
public Task<ChangeVisionPrivateEndpointCompartmentResponse> ChangeVisionPrivateEndpointCompartment(ChangeVisionPrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVisionPrivateEndpointCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeVisionPrivateEndpointCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeVisionPrivateEndpointCompartment API.

CreateDocumentJob(CreateDocumentJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a document analysis batch job.

Declaration
public Task<CreateDocumentJobResponse> CreateDocumentJob(CreateDocumentJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDocumentJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateDocumentJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDocumentJob API.

CreateImageJob(CreateImageJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an image analysis batch job.

Declaration
public Task<CreateImageJobResponse> CreateImageJob(CreateImageJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateImageJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateImageJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateImageJob API.

CreateModel(CreateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new model.

Declaration
public Task<CreateModelResponse> CreateModel(CreateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateModelRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateModelResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateModel API.

CreateProject(CreateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new project.

Declaration
public Task<CreateProjectResponse> CreateProject(CreateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateProjectRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateProjectResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateProject API.

CreateStreamGroup(CreateStreamGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Registration of new streamGroup

Declaration
public Task<CreateStreamGroupResponse> CreateStreamGroup(CreateStreamGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateStreamGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateStreamGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateStreamGroup API.

CreateStreamJob(CreateStreamJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a stream analysis job with given inputs and features.

Declaration
public Task<CreateStreamJobResponse> CreateStreamJob(CreateStreamJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateStreamJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateStreamJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateStreamJob API.

CreateStreamSource(CreateStreamSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Registration of new streamSource

Declaration
public Task<CreateStreamSourceResponse> CreateStreamSource(CreateStreamSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateStreamSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateStreamSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateStreamSource API.

CreateVideoJob(CreateVideoJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a video analysis job with given inputs and features.

Declaration
public Task<CreateVideoJobResponse> CreateVideoJob(CreateVideoJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVideoJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateVideoJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateVideoJob API.

CreateVisionPrivateEndpoint(CreateVisionPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new visionPrivateEndpoint.

Declaration
public Task<CreateVisionPrivateEndpointResponse> CreateVisionPrivateEndpoint(CreateVisionPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVisionPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateVisionPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateVisionPrivateEndpoint API.

DeleteModel(DeleteModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a model by identifier.

Declaration
public Task<DeleteModelResponse> DeleteModel(DeleteModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteModelRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteModelResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteModel API.

DeleteProject(DeleteProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a project by identifier.

Declaration
public Task<DeleteProjectResponse> DeleteProject(DeleteProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteProjectRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteProjectResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteProject API.

DeleteStreamGroup(DeleteStreamGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a streamGroup

Declaration
public Task<DeleteStreamGroupResponse> DeleteStreamGroup(DeleteStreamGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteStreamGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteStreamGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteStreamGroup API.

DeleteStreamJob(DeleteStreamJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details of a stream analysis job.

Declaration
public Task<DeleteStreamJobResponse> DeleteStreamJob(DeleteStreamJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteStreamJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteStreamJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteStreamJob API.

DeleteStreamSource(DeleteStreamSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a streamSource

Declaration
public Task<DeleteStreamSourceResponse> DeleteStreamSource(DeleteStreamSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteStreamSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteStreamSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteStreamSource API.

DeleteVisionPrivateEndpoint(DeleteVisionPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a visionPrivateEndpoint by identifier.

Declaration
public Task<DeleteVisionPrivateEndpointResponse> DeleteVisionPrivateEndpoint(DeleteVisionPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVisionPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteVisionPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteVisionPrivateEndpoint API.

GetDocumentJob(GetDocumentJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details of a document batch job.

Declaration
public Task<GetDocumentJobResponse> GetDocumentJob(GetDocumentJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDocumentJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDocumentJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDocumentJob API.

GetImageJob(GetImageJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details of an image batch job.

Declaration
public Task<GetImageJobResponse> GetImageJob(GetImageJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetImageJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetImageJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetImageJob API.

GetModel(GetModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a model by identifier.

Declaration
public Task<GetModelResponse> GetModel(GetModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModelRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetModelResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetModel API.

GetProject(GetProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a project by identifier.

Declaration
public Task<GetProjectResponse> GetProject(GetProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetProjectRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetProjectResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetProject API.

GetStreamGroup(GetStreamGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a streamGroup

Declaration
public Task<GetStreamGroupResponse> GetStreamGroup(GetStreamGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetStreamGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetStreamGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetStreamGroup API.

GetStreamJob(GetStreamJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details of a stream analysis job.

Declaration
public Task<GetStreamJobResponse> GetStreamJob(GetStreamJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetStreamJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetStreamJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetStreamJob API.

GetStreamSource(GetStreamSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a streamSource

Declaration
public Task<GetStreamSourceResponse> GetStreamSource(GetStreamSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetStreamSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetStreamSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetStreamSource API.

GetVideoJob(GetVideoJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details of a video analysis job.

Declaration
public Task<GetVideoJobResponse> GetVideoJob(GetVideoJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVideoJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetVideoJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetVideoJob API.

GetVisionPrivateEndpoint(GetVisionPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a visionPrivateEndpoint by identifier.

Declaration
public Task<GetVisionPrivateEndpointResponse> GetVisionPrivateEndpoint(GetVisionPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVisionPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetVisionPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetVisionPrivateEndpoint API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the status of the work request with the given ID.

Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetWorkRequestRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetWorkRequestResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListModels(ListModelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of models in a compartment.

Declaration
public Task<ListModelsResponse> ListModels(ListModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListModelsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListModelsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListModels API.

ListProjects(ListProjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of projects.

Declaration
public Task<ListProjectsResponse> ListProjects(ListProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListProjectsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListProjectsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListProjects API.

ListStreamGroups(ListStreamGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of the streamGroups in the specified compartment.

Declaration
public Task<ListStreamGroupsResponse> ListStreamGroups(ListStreamGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListStreamGroupsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListStreamGroupsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListStreamGroups API.

ListStreamJobs(ListStreamJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get list of stream jobs

Declaration
public Task<ListStreamJobsResponse> ListStreamJobs(ListStreamJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListStreamJobsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListStreamJobsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListStreamJobs API.

ListStreamSources(ListStreamSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of the streamSources in the specified compartment.

Declaration
public Task<ListStreamSourcesResponse> ListStreamSources(ListStreamSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListStreamSourcesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListStreamSourcesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListStreamSources API.

ListVisionPrivateEndpoints(ListVisionPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of visionPrivateEndpoints.

Declaration
public Task<ListVisionPrivateEndpointsResponse> ListVisionPrivateEndpoints(ListVisionPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVisionPrivateEndpointsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListVisionPrivateEndpointsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListVisionPrivateEndpoints API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a (paginated) list of errors for a given work request.

Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestErrorsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a (paginated) list of logs for a given work request.

Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestLogsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

StartStreamJob(StartStreamJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

End a stream analysis Run.

Declaration
public Task<StartStreamJobResponse> StartStreamJob(StartStreamJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StartStreamJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<StartStreamJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartStreamJob API.

StopStreamJob(StopStreamJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

End a stream analysis Run.

Declaration
public Task<StopStreamJobResponse> StopStreamJob(StopStreamJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StopStreamJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<StopStreamJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopStreamJob API.

UpdateModel(UpdateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the model metadata.

Declaration
public Task<UpdateModelResponse> UpdateModel(UpdateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateModelRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateModelResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateModel API.

UpdateProject(UpdateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the project metadata.

Declaration
public Task<UpdateProjectResponse> UpdateProject(UpdateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateProjectRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateProjectResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateProject API.

UpdateStreamGroup(UpdateStreamGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a streamGroup

Declaration
public Task<UpdateStreamGroupResponse> UpdateStreamGroup(UpdateStreamGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateStreamGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateStreamGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateStreamGroup API.

UpdateStreamJob(UpdateStreamJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a stream analysis job with given inputs and features.

Declaration
public Task<UpdateStreamJobResponse> UpdateStreamJob(UpdateStreamJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateStreamJobRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateStreamJobResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateStreamJob API.

UpdateStreamSource(UpdateStreamSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a streamSource

Declaration
public Task<UpdateStreamSourceResponse> UpdateStreamSource(UpdateStreamSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateStreamSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateStreamSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateStreamSource API.

UpdateVisionPrivateEndpoint(UpdateVisionPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the visionPrivateEndpoint metadata.

Declaration
public Task<UpdateVisionPrivateEndpointResponse> UpdateVisionPrivateEndpoint(UpdateVisionPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVisionPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateVisionPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateVisionPrivateEndpoint API.

Implements

IDisposable
In this article
Back to top