Class EnrichmentJobClient

Service client instance for EnrichmentJob.

Inheritance

object

ClientBase

RegionalClientBase

EnrichmentJobClient

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)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaidataService

Assembly: OCI.DotNetSDK.Generativeaidata.dll

Syntax

public class EnrichmentJobClient : RegionalClientBase, IDisposable

Constructors

EnrichmentJobClient(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 EnrichmentJobClient(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 EnrichmentJobPaginators Paginators { get; }

Property Value

Type	Description
EnrichmentJobPaginators

Waiters

Declaration

public EnrichmentJobWaiters Waiters { get; }

Property Value

Type	Description
EnrichmentJobWaiters

Methods

CancelEnrichmentJob(CancelEnrichmentJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels an EnrichmentJob resource by identifier. The returned job includes the modelId used for enrichment.

Declaration

public Task<CancelEnrichmentJobResponse> CancelEnrichmentJob(CancelEnrichmentJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelEnrichmentJobRequest	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<CancelEnrichmentJobResponse>	A response object containing details about the completed operation

Examples

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

GenerateEnrichmentJob(GenerateEnrichmentJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new asynchronous EnrichmentJob. The returned job includes the modelId used for enrichment.

Declaration

public Task<GenerateEnrichmentJobResponse> GenerateEnrichmentJob(GenerateEnrichmentJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateEnrichmentJobRequest	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<GenerateEnrichmentJobResponse>	A response object containing details about the completed operation

Examples

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

GetEnrichmentJob(GetEnrichmentJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an EnrichmentJob by identifier. The returned job includes the modelId used for enrichment.

Declaration

public Task<GetEnrichmentJobResponse> GetEnrichmentJob(GetEnrichmentJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetEnrichmentJobRequest	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<GetEnrichmentJobResponse>	A response object containing details about the completed operation

Examples

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

ListEnrichmentJobs(ListEnrichmentJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists EnrichmentJobs in a semantic store. Each returned job summary includes the modelId used for enrichment.

Declaration

public Task<ListEnrichmentJobsResponse> ListEnrichmentJobs(ListEnrichmentJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListEnrichmentJobsRequest	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<ListEnrichmentJobsResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable