Package com.oracle.bmc.fleetappsmanagement

Class FleetAppsManagementRunbooksClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.fleetappsmanagement.FleetAppsManagementRunbooksClient

All Implemented Interfaces:

FleetAppsManagementRunbooks, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230831")
public class FleetAppsManagementRunbooksClient
extends BaseSyncClient
implements FleetAppsManagementRunbooks

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FleetAppsManagementRunbooksClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for FleetAppsManagementRunbooks.

Constructor Summary

Constructors

Constructor	Description
FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static FleetAppsManagementRunbooksClient.Builder	builder()	Create a builder for this client.
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PublishRunbookResponse	publishRunbook(PublishRunbookRequest request)	Publish a Runbook.
void	refreshClient()	Rebuild the backing HttpClient.
SetDefaultRunbookResponse	setDefaultRunbook(SetDefaultRunbookRequest request)	Publish a Runbook.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateRunbookResponse	updateRunbook(UpdateRunbookRequest request)	Updates the Ronbook
UpdateTaskRecordResponse	updateTaskRecord(UpdateTaskRecordRequest request)	Updates the Task
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.fleetappsmanagement.FleetAppsManagementRunbooks

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for FleetAppsManagementRunbooks.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

FleetAppsManagementRunbooksClient

@Deprecated
public FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint,
                                         ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - FleetAppsManagementRunbooksClient.Builder.executorService

Method Detail

builder

public static FleetAppsManagementRunbooksClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: FleetAppsManagementRunbooks

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.

Specified by:

setRegion in interface FleetAppsManagementRunbooks

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: FleetAppsManagementRunbooks

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.

Specified by:

setRegion in interface FleetAppsManagementRunbooks

Parameters:

regionId - The public region ID.

createRunbook

public CreateRunbookResponse createRunbook(CreateRunbookRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Creates a new Runbook.

Specified by:

createRunbook in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createTaskRecord

public CreateTaskRecordResponse createTaskRecord(CreateTaskRecordRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Creates a new Task.

Specified by:

createTaskRecord in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRunbook

public DeleteRunbookResponse deleteRunbook(DeleteRunbookRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Deletes a Runbook resource by identifier

Specified by:

deleteRunbook in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteTaskRecord

public DeleteTaskRecordResponse deleteTaskRecord(DeleteTaskRecordRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Deletes a Task Record resource by identifier

Specified by:

deleteTaskRecord in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRunbook

public GetRunbookResponse getRunbook(GetRunbookRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Get the details of a runbook in Fleet Application Management.

Specified by:

getRunbook in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTaskRecord

public GetTaskRecordResponse getTaskRecord(GetTaskRecordRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Gets a Task by identifier

Specified by:

getTaskRecord in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRunbooks

public ListRunbooksResponse listRunbooks(ListRunbooksRequest request)

Description copied from interface: FleetAppsManagementRunbooks

List runbooks in Fleet Application Management.

Specified by:

listRunbooks in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTaskRecords

public ListTaskRecordsResponse listTaskRecords(ListTaskRecordsRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Returns a list of TaskRecords.

Specified by:

listTaskRecords in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

publishRunbook

public PublishRunbookResponse publishRunbook(PublishRunbookRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Publish a Runbook.

Specified by:

publishRunbook in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

setDefaultRunbook

public SetDefaultRunbookResponse setDefaultRunbook(SetDefaultRunbookRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Publish a Runbook.

Specified by:

setDefaultRunbook in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRunbook

public UpdateRunbookResponse updateRunbook(UpdateRunbookRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Updates the Ronbook

Specified by:

updateRunbook in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateTaskRecord

public UpdateTaskRecordResponse updateTaskRecord(UpdateTaskRecordRequest request)

Description copied from interface: FleetAppsManagementRunbooks

Updates the Task

Specified by:

updateTaskRecord in interface FleetAppsManagementRunbooks

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public FleetAppsManagementRunbooksWaiters getWaiters()

Description copied from interface: FleetAppsManagementRunbooks

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface FleetAppsManagementRunbooks

Returns:

The service waiters.

getPaginators

public FleetAppsManagementRunbooksPaginators getPaginators()

Description copied from interface: FleetAppsManagementRunbooks

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.

Specified by:

getPaginators in interface FleetAppsManagementRunbooks

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()