Class ScheduledJobClient
Service client instance for ScheduledJob.
Implements
Inherited Members
Namespace: Oci.OsmanagementhubService
Assembly: OCI.DotNetSDK.Osmanagementhub.dll
Syntax
public class ScheduledJobClient : RegionalClientBase, IDisposable
Constructors
ScheduledJobClient(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 ScheduledJobClient(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 ScheduledJobPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ScheduledJobPaginators |
Waiters
Declaration
public ScheduledJobWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
ScheduledJobWaiters |
Methods
ChangeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a scheduled job to another compartment.
Declaration
public Task<ChangeScheduledJobCompartmentResponse> ChangeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeScheduledJobCompartmentRequest | 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<ChangeScheduledJobCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeScheduledJobCompartment API.
CreateScheduledJob(CreateScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new scheduled job.
Declaration
public Task<CreateScheduledJobResponse> CreateScheduledJob(CreateScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateScheduledJobRequest | 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<CreateScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateScheduledJob API.
DeleteScheduledJob(DeleteScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified scheduled job.
Declaration
public Task<DeleteScheduledJobResponse> DeleteScheduledJob(DeleteScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteScheduledJobRequest | 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<DeleteScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteScheduledJob API.
GetScheduledJob(GetScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified scheduled job.
Declaration
public Task<GetScheduledJobResponse> GetScheduledJob(GetScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetScheduledJobRequest | 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<GetScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetScheduledJob API.
ListScheduledJobs(ListScheduledJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists scheduled jobs that match the specified compartment or scheduled job OCID.
Declaration
public Task<ListScheduledJobsResponse> ListScheduledJobs(ListScheduledJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListScheduledJobsRequest | 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<ListScheduledJobsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListScheduledJobs API.
RunScheduledJobNow(RunScheduledJobNowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly scheduled time. This operation only applies to recurring jobs, not one-time scheduled jobs.
Declaration
public Task<RunScheduledJobNowResponse> RunScheduledJobNow(RunScheduledJobNowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RunScheduledJobNowRequest | 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<RunScheduledJobNowResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RunScheduledJobNow API.
UpdateScheduledJob(UpdateScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified scheduled job's name, description, and other details, such as next execution and recurrence.
Declaration
public Task<UpdateScheduledJobResponse> UpdateScheduledJob(UpdateScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateScheduledJobRequest | 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<UpdateScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateScheduledJob API.