@Generated(value="OracleSDKGenerator", comments="API Version: 20230831") public interface FleetAppsManagementOperations extends AutoCloseable
Fleet Application Management Service API. Use this API to for all FAMS related activities. To manage fleets,view complaince report for the Fleet,scedule patches and other lifecycle activities
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
CreateSchedulerDefinitionResponse |
createSchedulerDefinition(CreateSchedulerDefinitionRequest request)
Creates a new SchedulerDefinition.
|
DeleteSchedulerDefinitionResponse |
deleteSchedulerDefinition(DeleteSchedulerDefinitionRequest request)
Deletes a SchedulerDefinition resource by identifier
|
DeleteSchedulerJobResponse |
deleteSchedulerJob(DeleteSchedulerJobRequest request)
Deletes a SchedulerJob resource by identifier
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetExecutionResponse |
getExecution(GetExecutionRequest request)
Gets a JobActivity by identifier
|
GetJobActivityResponse |
getJobActivity(GetJobActivityRequest request)
Gets a JobActivity by identifier
|
FleetAppsManagementOperationsPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetSchedulerDefinitionResponse |
getSchedulerDefinition(GetSchedulerDefinitionRequest request)
Gets a SchedulerDefinition by identifier
|
GetSchedulerJobResponse |
getSchedulerJob(GetSchedulerJobRequest request)
Gets a SchedulerJob by identifier
|
FleetAppsManagementOperationsWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListExecutionsResponse |
listExecutions(ListExecutionsRequest request)
Returns a list of Task Executions for a Resource.
|
ListScheduledFleetsResponse |
listScheduledFleets(ListScheduledFleetsRequest request)
Returns a list of ScheduledFleets
|
ListSchedulerDefinitionsResponse |
listSchedulerDefinitions(ListSchedulerDefinitionsRequest request)
Returns a list of SchedulerDefinitions.
|
ListSchedulerJobsResponse |
listSchedulerJobs(ListSchedulerJobsRequest request)
Returns a list of SchedulerJobs.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
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’).
|
UpdateSchedulerDefinitionResponse |
updateSchedulerDefinition(UpdateSchedulerDefinitionRequest request)
Updates the SchedulerDefinition
|
UpdateSchedulerJobResponse |
updateSchedulerJob(UpdateSchedulerJobRequest request)
Updates the SchedulerJob
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateCreateSchedulerDefinitionResponse createSchedulerDefinition(CreateSchedulerDefinitionRequest request)
Creates a new SchedulerDefinition.
request
- The request object containing the details to sendBmcException
- 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 CreateSchedulerDefinition API.
DeleteSchedulerDefinitionResponse deleteSchedulerDefinition(DeleteSchedulerDefinitionRequest request)
Deletes a SchedulerDefinition resource by identifier
request
- The request object containing the details to sendBmcException
- 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 DeleteSchedulerDefinition API.
DeleteSchedulerJobResponse deleteSchedulerJob(DeleteSchedulerJobRequest request)
Deletes a SchedulerJob resource by identifier
request
- The request object containing the details to sendBmcException
- 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 DeleteSchedulerJob API.
GetExecutionResponse getExecution(GetExecutionRequest request)
Gets a JobActivity by identifier
request
- The request object containing the details to sendBmcException
- 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 GetExecution API.
GetJobActivityResponse getJobActivity(GetJobActivityRequest request)
Gets a JobActivity by identifier
request
- The request object containing the details to sendBmcException
- 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 GetJobActivity API.
GetSchedulerDefinitionResponse getSchedulerDefinition(GetSchedulerDefinitionRequest request)
Gets a SchedulerDefinition by identifier
request
- The request object containing the details to sendBmcException
- 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 GetSchedulerDefinition API.
GetSchedulerJobResponse getSchedulerJob(GetSchedulerJobRequest request)
Gets a SchedulerJob by identifier
request
- The request object containing the details to sendBmcException
- 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 GetSchedulerJob API.
ListExecutionsResponse listExecutions(ListExecutionsRequest request)
Returns a list of Task Executions for a Resource.
request
- The request object containing the details to sendBmcException
- 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 ListExecutions API.
ListScheduledFleetsResponse listScheduledFleets(ListScheduledFleetsRequest request)
Returns a list of ScheduledFleets
request
- The request object containing the details to sendBmcException
- 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 ListScheduledFleets API.
ListSchedulerDefinitionsResponse listSchedulerDefinitions(ListSchedulerDefinitionsRequest request)
Returns a list of SchedulerDefinitions.
request
- The request object containing the details to sendBmcException
- 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 ListSchedulerDefinitions API.
ListSchedulerJobsResponse listSchedulerJobs(ListSchedulerJobsRequest request)
Returns a list of SchedulerJobs.
request
- The request object containing the details to sendBmcException
- 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 ListSchedulerJobs API.
UpdateSchedulerDefinitionResponse updateSchedulerDefinition(UpdateSchedulerDefinitionRequest request)
Updates the SchedulerDefinition
request
- The request object containing the details to sendBmcException
- 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 UpdateSchedulerDefinition API.
UpdateSchedulerJobResponse updateSchedulerJob(UpdateSchedulerJobRequest request)
Updates the SchedulerJob
request
- The request object containing the details to sendBmcException
- 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 UpdateSchedulerJob API.
FleetAppsManagementOperationsWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
FleetAppsManagementOperationsPaginators 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.
Copyright © 2016–2024. All rights reserved.