FleetAppsManagementRunbooks (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FleetAppsManagementRunbooksClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230831")
public interface FleetAppsManagementRunbooks
extends AutoCloseable
```
Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateRunbookResponse`	`createRunbook(CreateRunbookRequest request)` Creates a new Runbook.
`CreateTaskRecordResponse`	`createTaskRecord(CreateTaskRecordRequest request)` Creates a new Task.
`DeleteRunbookResponse`	`deleteRunbook(DeleteRunbookRequest request)` Deletes a Runbook resource by identifier
`DeleteTaskRecordResponse`	`deleteTaskRecord(DeleteTaskRecordRequest request)` Deletes a Task Record resource by identifier
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`FleetAppsManagementRunbooksPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetRunbookResponse`	`getRunbook(GetRunbookRequest request)` Get the details of a runbook in Fleet Application Management.
`GetTaskRecordResponse`	`getTaskRecord(GetTaskRecordRequest request)` Gets a Task by identifier
`FleetAppsManagementRunbooksWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListRunbooksResponse`	`listRunbooks(ListRunbooksRequest request)` List runbooks in Fleet Application Management.
`ListTaskRecordsResponse`	`listTaskRecords(ListTaskRecordsRequest request)` Returns a list of TaskRecords.
`PublishRunbookResponse`	`publishRunbook(PublishRunbookRequest request)` Publish a Runbook.
`void`	`refreshClient()` Rebuilds the client from scratch.
`SetDefaultRunbookResponse`	`setDefaultRunbook(SetDefaultRunbookRequest request)` Publish a Runbook.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateRunbookResponse`	`updateRunbook(UpdateRunbookRequest request)` Updates the Ronbook
`UpdateTaskRecordResponse`	`updateTaskRecord(UpdateTaskRecordRequest request)` Updates the Task
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - createRunbook
```
CreateRunbookResponse createRunbook(CreateRunbookRequest request)
```
    Creates a new Runbook.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateRunbook API.
  - createTaskRecord
```
CreateTaskRecordResponse createTaskRecord(CreateTaskRecordRequest request)
```
    Creates a new Task.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateTaskRecord API.
  - deleteRunbook
```
DeleteRunbookResponse deleteRunbook(DeleteRunbookRequest request)
```
    Deletes a Runbook resource by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteRunbook API.
  - deleteTaskRecord
```
DeleteTaskRecordResponse deleteTaskRecord(DeleteTaskRecordRequest request)
```
    Deletes a Task Record resource by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteTaskRecord API.
  - getRunbook
```
GetRunbookResponse getRunbook(GetRunbookRequest request)
```
    Get the details of a runbook in Fleet Application Management.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetRunbook API.
  - getTaskRecord
```
GetTaskRecordResponse getTaskRecord(GetTaskRecordRequest request)
```
    Gets a Task by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetTaskRecord API.
  - listRunbooks
```
ListRunbooksResponse listRunbooks(ListRunbooksRequest request)
```
    List runbooks in Fleet Application Management.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListRunbooks API.
  - listTaskRecords
```
ListTaskRecordsResponse listTaskRecords(ListTaskRecordsRequest request)
```
    Returns a list of TaskRecords.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListTaskRecords API.
  - publishRunbook
```
PublishRunbookResponse publishRunbook(PublishRunbookRequest request)
```
    Publish a Runbook.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use PublishRunbook API.
  - setDefaultRunbook
```
SetDefaultRunbookResponse setDefaultRunbook(SetDefaultRunbookRequest request)
```
    Publish a Runbook.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use SetDefaultRunbook API.
  - updateRunbook
```
UpdateRunbookResponse updateRunbook(UpdateRunbookRequest request)
```
    Updates the Ronbook
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateRunbook API.
  - updateTaskRecord
```
UpdateTaskRecordResponse updateTaskRecord(UpdateTaskRecordRequest request)
```
    Updates the Task
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateTaskRecord API.
  - getWaiters
```
FleetAppsManagementRunbooksWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
FleetAppsManagementRunbooksPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface FleetAppsManagementRunbooks

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

createRunbook

createTaskRecord

deleteRunbook

deleteTaskRecord

getRunbook

getTaskRecord

listRunbooks

listTaskRecords

publishRunbook

setDefaultRunbook

updateRunbook

updateTaskRecord

getWaiters

getPaginators