Class FleetAppsManagementRunbooksClient

Service client instance for FleetAppsManagementRunbooks.

Inheritance

object

ClientBase

RegionalClientBase

FleetAppsManagementRunbooksClient

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.FleetappsmanagementService

Assembly: OCI.DotNetSDK.Fleetappsmanagement.dll

Syntax

public class FleetAppsManagementRunbooksClient : RegionalClientBase, IDisposable

Constructors

FleetAppsManagementRunbooksClient(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 FleetAppsManagementRunbooksClient(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 FleetAppsManagementRunbooksPaginators Paginators { get; }

Property Value

Type	Description
FleetAppsManagementRunbooksPaginators

Waiters

Declaration

public FleetAppsManagementRunbooksWaiters Waiters { get; }

Property Value

Type	Description
FleetAppsManagementRunbooksWaiters

Methods

ChangeRunbookCompartment(ChangeRunbookCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a Runbook 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<ChangeRunbookCompartmentResponse> ChangeRunbookCompartment(ChangeRunbookCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangeTaskRecordCompartment(ChangeTaskRecordCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a task record 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<ChangeTaskRecordCompartmentResponse> ChangeTaskRecordCompartment(ChangeTaskRecordCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateRunbook(CreateRunbookRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a runbook.

Declaration

public Task<CreateRunbookResponse> CreateRunbook(CreateRunbookRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateRunbookVersion(CreateRunbookVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Add RunbookVersion in\u00A0Fleet Application Management.

Declaration

public Task<CreateRunbookVersionResponse> CreateRunbookVersion(CreateRunbookVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateTaskRecord(CreateTaskRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new task record.

Declaration

public Task<CreateTaskRecordResponse> CreateTaskRecord(CreateTaskRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteRunbook(DeleteRunbookRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a runbook specified by the identifier.

Declaration

public Task<DeleteRunbookResponse> DeleteRunbook(DeleteRunbookRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteRunbookVersion(DeleteRunbookVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a Runbook Version from the runbook in Fleet Application Management.

Declaration

public Task<DeleteRunbookVersionResponse> DeleteRunbookVersion(DeleteRunbookVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteTaskRecord(DeleteTaskRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the task record specified by an identifier.

Declaration

public Task<DeleteTaskRecordResponse> DeleteTaskRecord(DeleteTaskRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetRunbook(GetRunbookRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the details of a runbook in Fleet Application Management.

Declaration

public Task<GetRunbookResponse> GetRunbook(GetRunbookRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetRunbookVersion(GetRunbookVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a Runbook Version by identifier.

Declaration

public Task<GetRunbookVersionResponse> GetRunbookVersion(GetRunbookVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetTaskRecord(GetTaskRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified task record.

Declaration

public Task<GetTaskRecordResponse> GetTaskRecord(GetTaskRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListRunbookVersions(ListRunbookVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List versions for a runbook in Fleet Application Management.

Declaration

public Task<ListRunbookVersionsResponse> ListRunbookVersions(ListRunbookVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListRunbooks(ListRunbooksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of all the runbooks in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Declaration

public Task<ListRunbooksResponse> ListRunbooks(ListRunbooksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListTaskRecords(ListTaskRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of all the task records in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Declaration

public Task<ListTaskRecordsResponse> ListTaskRecords(ListTaskRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

PublishRunbook(PublishRunbookRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Publish the specified version of the runbook. The specified version of the runbook becomes acitve when it is published.Only active versions of runbook can be used in execution.

Declaration

public Task<PublishRunbookResponse> PublishRunbook(PublishRunbookRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

SetDefaultRunbook(SetDefaultRunbookRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Set a runbook as default.

Declaration

public Task<SetDefaultRunbookResponse> SetDefaultRunbook(SetDefaultRunbookRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateRunbook(UpdateRunbookRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the runbook specified by the identifier.

Declaration

public Task<UpdateRunbookResponse> UpdateRunbook(UpdateRunbookRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateRunbookVersion(UpdateRunbookVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the RunbookVersion.

Declaration

public Task<UpdateRunbookVersionResponse> UpdateRunbookVersion(UpdateRunbookVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateTaskRecord(UpdateTaskRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates certain attributes for the specified task record.

Declaration

public Task<UpdateTaskRecordResponse> UpdateTaskRecord(UpdateTaskRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable