Class BatchComputingClient

Service client instance for BatchComputing.

Inheritance
object
ClientBase
RegionalClientBase
BatchComputingClient
Implements
Inherited Members
Namespace: Oci.BatchService
Assembly: OCI.DotNetSDK.Batch.dll
Syntax
public class BatchComputingClient : RegionalClientBase, IDisposable

Constructors

BatchComputingClient(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 BatchComputingClient(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 BatchComputingPaginators Paginators { get; }
Property Value
Type Description
BatchComputingPaginators

Waiters

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

Methods

CancelBatchJob(CancelBatchJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a batch job.

Declaration
public Task<CancelBatchJobResponse> CancelBatchJob(CancelBatchJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelBatchJobRequest 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<CancelBatchJobResponse>

A response object containing details about the completed operation
Examples

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

ChangeBatchContextCompartment(ChangeBatchContextCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a batch context into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeBatchContextCompartmentResponse> ChangeBatchContextCompartment(ChangeBatchContextCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeBatchContextCompartmentRequest 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<ChangeBatchContextCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeBatchJobCompartment(ChangeBatchJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a batch job into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeBatchJobCompartmentResponse> ChangeBatchJobCompartment(ChangeBatchJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeBatchJobCompartmentRequest 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<ChangeBatchJobCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeBatchJobPoolCompartment(ChangeBatchJobPoolCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a batch job pool into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeBatchJobPoolCompartmentResponse> ChangeBatchJobPoolCompartment(ChangeBatchJobPoolCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeBatchJobPoolCompartmentRequest 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<ChangeBatchJobPoolCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeBatchTaskEnvironmentCompartment(ChangeBatchTaskEnvironmentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a batch task environment into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeBatchTaskEnvironmentCompartmentResponse> ChangeBatchTaskEnvironmentCompartment(ChangeBatchTaskEnvironmentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeBatchTaskEnvironmentCompartmentRequest 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<ChangeBatchTaskEnvironmentCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeBatchTaskProfileCompartment(ChangeBatchTaskProfileCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a batch task profile into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeBatchTaskProfileCompartmentResponse> ChangeBatchTaskProfileCompartment(ChangeBatchTaskProfileCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeBatchTaskProfileCompartmentRequest 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<ChangeBatchTaskProfileCompartmentResponse>

A response object containing details about the completed operation
Examples

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

CreateBatchContext(CreateBatchContextRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a batch context.

Declaration
public Task<CreateBatchContextResponse> CreateBatchContext(CreateBatchContextRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBatchContextRequest 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<CreateBatchContextResponse>

A response object containing details about the completed operation
Examples

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

CreateBatchJob(CreateBatchJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a batch job.

Declaration
public Task<CreateBatchJobResponse> CreateBatchJob(CreateBatchJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBatchJobRequest 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<CreateBatchJobResponse>

A response object containing details about the completed operation
Examples

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

CreateBatchJobPool(CreateBatchJobPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a batch job pool.

Declaration
public Task<CreateBatchJobPoolResponse> CreateBatchJobPool(CreateBatchJobPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBatchJobPoolRequest 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<CreateBatchJobPoolResponse>

A response object containing details about the completed operation
Examples

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

CreateBatchTaskEnvironment(CreateBatchTaskEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a batch task environment.

Declaration
public Task<CreateBatchTaskEnvironmentResponse> CreateBatchTaskEnvironment(CreateBatchTaskEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBatchTaskEnvironmentRequest 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<CreateBatchTaskEnvironmentResponse>

A response object containing details about the completed operation
Examples

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

CreateBatchTaskProfile(CreateBatchTaskProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a batch task profile.

Declaration
public Task<CreateBatchTaskProfileResponse> CreateBatchTaskProfile(CreateBatchTaskProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBatchTaskProfileRequest 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<CreateBatchTaskProfileResponse>

A response object containing details about the completed operation
Examples

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

DeleteBatchContext(DeleteBatchContextRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a batch context. All batch job pools associated with the batch context must be deleted beforehand.

Declaration
public Task<DeleteBatchContextResponse> DeleteBatchContext(DeleteBatchContextRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBatchContextRequest 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<DeleteBatchContextResponse>

A response object containing details about the completed operation
Examples

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

DeleteBatchJobPool(DeleteBatchJobPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a batch job pool. All batch jobs associated with the batch job pool must be canceled beforehand.

Declaration
public Task<DeleteBatchJobPoolResponse> DeleteBatchJobPool(DeleteBatchJobPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBatchJobPoolRequest 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<DeleteBatchJobPoolResponse>

A response object containing details about the completed operation
Examples

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

DeleteBatchTaskEnvironment(DeleteBatchTaskEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a batch task environment. All batch tasks associated with the batch task environment must be canceled beforehand.

Declaration
public Task<DeleteBatchTaskEnvironmentResponse> DeleteBatchTaskEnvironment(DeleteBatchTaskEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBatchTaskEnvironmentRequest 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<DeleteBatchTaskEnvironmentResponse>

A response object containing details about the completed operation
Examples

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

DeleteBatchTaskProfile(DeleteBatchTaskProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a batch task profile. All batch tasks associated with the batch task profile must be canceled beforehand.

Declaration
public Task<DeleteBatchTaskProfileResponse> DeleteBatchTaskProfile(DeleteBatchTaskProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBatchTaskProfileRequest 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<DeleteBatchTaskProfileResponse>

A response object containing details about the completed operation
Examples

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

GetBatchContext(GetBatchContextRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a batch context.

Declaration
public Task<GetBatchContextResponse> GetBatchContext(GetBatchContextRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBatchContextRequest 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<GetBatchContextResponse>

A response object containing details about the completed operation
Examples

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

GetBatchJob(GetBatchJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a batch job.

Declaration
public Task<GetBatchJobResponse> GetBatchJob(GetBatchJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBatchJobRequest 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<GetBatchJobResponse>

A response object containing details about the completed operation
Examples

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

GetBatchJobPool(GetBatchJobPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a batch job pool.

Declaration
public Task<GetBatchJobPoolResponse> GetBatchJobPool(GetBatchJobPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBatchJobPoolRequest 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<GetBatchJobPoolResponse>

A response object containing details about the completed operation
Examples

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

GetBatchTask(GetBatchTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a specific batch task associated with a batch job by its name.

Declaration
public Task<GetBatchTaskResponse> GetBatchTask(GetBatchTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBatchTaskRequest 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<GetBatchTaskResponse>

A response object containing details about the completed operation
Examples

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

GetBatchTaskEnvironment(GetBatchTaskEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a batch task environment.

Declaration
public Task<GetBatchTaskEnvironmentResponse> GetBatchTaskEnvironment(GetBatchTaskEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBatchTaskEnvironmentRequest 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<GetBatchTaskEnvironmentResponse>

A response object containing details about the completed operation
Examples

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

GetBatchTaskProfile(GetBatchTaskProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a batch task profile.

Declaration
public Task<GetBatchTaskProfileResponse> GetBatchTaskProfile(GetBatchTaskProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBatchTaskProfileRequest 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<GetBatchTaskProfileResponse>

A response object containing details about the completed operation
Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a work request.

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.

ListBatchContextShapes(ListBatchContextShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the shapes allowed to be specified during batch context creation. Ordered by the shape name.

Declaration
public Task<ListBatchContextShapesResponse> ListBatchContextShapes(ListBatchContextShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchContextShapesRequest 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<ListBatchContextShapesResponse>

A response object containing details about the completed operation
Examples

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

ListBatchContexts(ListBatchContextsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the batch contexts by compartment or context OCID. You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchContext to get the full details on a specific context

Declaration
public Task<ListBatchContextsResponse> ListBatchContexts(ListBatchContextsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchContextsRequest 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<ListBatchContextsResponse>

A response object containing details about the completed operation
Examples

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

ListBatchJobPools(ListBatchJobPoolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the batch job pools by compartment or job pool OCID. You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJobPool to get the full details on a specific context

Declaration
public Task<ListBatchJobPoolsResponse> ListBatchJobPools(ListBatchJobPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchJobPoolsRequest 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<ListBatchJobPoolsResponse>

A response object containing details about the completed operation
Examples

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

ListBatchJobTasks(ListBatchJobTasksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the batch tasks by batch job OCID. You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTask to get the full details on a specific context List is incomplete until jobs lifecycle is in_progress

Declaration
public Task<ListBatchJobTasksResponse> ListBatchJobTasks(ListBatchJobTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchJobTasksRequest 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<ListBatchJobTasksResponse>

A response object containing details about the completed operation
Examples

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

ListBatchJobs(ListBatchJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the batch jobs by compartment or job OCID. You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJob to get the full details on a specific context

Declaration
public Task<ListBatchJobsResponse> ListBatchJobs(ListBatchJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchJobsRequest 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<ListBatchJobsResponse>

A response object containing details about the completed operation
Examples

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

ListBatchTaskEnvironments(ListBatchTaskEnvironmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the task environments by compartment or environment OCID. You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskEnvironment to get the full details on a specific context

Declaration
public Task<ListBatchTaskEnvironmentsResponse> ListBatchTaskEnvironments(ListBatchTaskEnvironmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchTaskEnvironmentsRequest 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<ListBatchTaskEnvironmentsResponse>

A response object containing details about the completed operation
Examples

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

ListBatchTaskProfiles(ListBatchTaskProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the task profiles by compartment or profile OCID. You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskProfile to get the full details on a specific context

Declaration
public Task<ListBatchTaskProfilesResponse> ListBatchTaskProfiles(ListBatchTaskProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchTaskProfilesRequest 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<ListBatchTaskProfilesResponse>

A response object containing details about the completed operation
Examples

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

ListBatchTasks(ListBatchTasksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the batch tasks associated with batch jobs.

Declaration
public Task<ListBatchTasksResponse> ListBatchTasks(ListBatchTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBatchTasksRequest 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<ListBatchTasksResponse>

A response object containing details about the completed operation
Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the errors for a 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)

Lists the logs for a 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.

PauseBatchJob(PauseBatchJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Pauses the batch job and all its tasks.

Declaration
public Task<PauseBatchJobResponse> PauseBatchJob(PauseBatchJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
PauseBatchJobRequest 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<PauseBatchJobResponse>

A response object containing details about the completed operation
Examples

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

StartBatchContext(StartBatchContextRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activates a batch context to accept new jobs.

Declaration
public Task<StartBatchContextResponse> StartBatchContext(StartBatchContextRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StartBatchContextRequest 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<StartBatchContextResponse>

A response object containing details about the completed operation
Examples

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

StartBatchJobPool(StartBatchJobPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activates the batch job pool.

Declaration
public Task<StartBatchJobPoolResponse> StartBatchJobPool(StartBatchJobPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StartBatchJobPoolRequest 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<StartBatchJobPoolResponse>

A response object containing details about the completed operation
Examples

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

StopBatchContext(StopBatchContextRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops a batch context from accepting new jobs.

Declaration
public Task<StopBatchContextResponse> StopBatchContext(StopBatchContextRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StopBatchContextRequest 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<StopBatchContextResponse>

A response object containing details about the completed operation
Examples

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

StopBatchJobPool(StopBatchJobPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deactivates the batch job pool.

Declaration
public Task<StopBatchJobPoolResponse> StopBatchJobPool(StopBatchJobPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StopBatchJobPoolRequest 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<StopBatchJobPoolResponse>

A response object containing details about the completed operation
Examples

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

UnpauseBatchJob(UnpauseBatchJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resumes the batch job and all its tasks.

Declaration
public Task<UnpauseBatchJobResponse> UnpauseBatchJob(UnpauseBatchJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UnpauseBatchJobRequest 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<UnpauseBatchJobResponse>

A response object containing details about the completed operation
Examples

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

UpdateBatchContext(UpdateBatchContextRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a batch context.

Declaration
public Task<UpdateBatchContextResponse> UpdateBatchContext(UpdateBatchContextRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBatchContextRequest 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<UpdateBatchContextResponse>

A response object containing details about the completed operation
Examples

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

UpdateBatchJob(UpdateBatchJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a batch job.

Declaration
public Task<UpdateBatchJobResponse> UpdateBatchJob(UpdateBatchJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBatchJobRequest 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<UpdateBatchJobResponse>

A response object containing details about the completed operation
Examples

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

UpdateBatchJobPool(UpdateBatchJobPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a batch job pool.

Declaration
public Task<UpdateBatchJobPoolResponse> UpdateBatchJobPool(UpdateBatchJobPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBatchJobPoolRequest 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<UpdateBatchJobPoolResponse>

A response object containing details about the completed operation
Examples

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

UpdateBatchTaskEnvironment(UpdateBatchTaskEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a batch task environment.

Declaration
public Task<UpdateBatchTaskEnvironmentResponse> UpdateBatchTaskEnvironment(UpdateBatchTaskEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBatchTaskEnvironmentRequest 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<UpdateBatchTaskEnvironmentResponse>

A response object containing details about the completed operation
Examples

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

UpdateBatchTaskProfile(UpdateBatchTaskProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a batch task profile.

Declaration
public Task<UpdateBatchTaskProfileResponse> UpdateBatchTaskProfile(UpdateBatchTaskProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBatchTaskProfileRequest 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<UpdateBatchTaskProfileResponse>

A response object containing details about the completed operation
Examples

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

Implements