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: 20250228") 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 thebuilder
instead.FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.FleetAppsManagementRunbooksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FleetAppsManagementRunbooksClient.Builder
builder()
Create a builder for this client.ChangeRunbookCompartmentResponse
changeRunbookCompartment(ChangeRunbookCompartmentRequest request)
Moves a Runbook into a different compartment within the same tenancy.ChangeTaskRecordCompartmentResponse
changeTaskRecordCompartment(ChangeTaskRecordCompartmentRequest request)
Moves a task record into a different compartment within the same tenancy.void
close()
CreateRunbookResponse
createRunbook(CreateRunbookRequest request)
Creates a runbook.CreateRunbookVersionResponse
createRunbookVersion(CreateRunbookVersionRequest request)
Add RunbookVersion inĀ Fleet Application Management.CreateTaskRecordResponse
createTaskRecord(CreateTaskRecordRequest request)
Creates a new task record.DeleteRunbookResponse
deleteRunbook(DeleteRunbookRequest request)
Deletes a runbook specified by the identifier.DeleteRunbookVersionResponse
deleteRunbookVersion(DeleteRunbookVersionRequest request)
Removes a Runbook Version from the runbook in Fleet Application Management.DeleteTaskRecordResponse
deleteTaskRecord(DeleteTaskRecordRequest request)
Deletes the task record specified by an 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.GetRunbookVersionResponse
getRunbookVersion(GetRunbookVersionRequest request)
Gets a Runbook Version by identifier.GetTaskRecordResponse
getTaskRecord(GetTaskRecordRequest request)
Gets information for the specified task record.FleetAppsManagementRunbooksWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListRunbooksResponse
listRunbooks(ListRunbooksRequest request)
Returns a list of all the runbooks in the specified compartment.ListRunbookVersionsResponse
listRunbookVersions(ListRunbookVersionsRequest request)
List versions for a runbook in Fleet Application Management.ListTaskRecordsResponse
listTaskRecords(ListTaskRecordsRequest request)
Returns a list of all the task records in the specified compartment.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 the specified version of the runbook.void
refreshClient()
Rebuild the backingHttpClient
.SetDefaultRunbookResponse
setDefaultRunbook(SetDefaultRunbookRequest request)
Set a runbook as default.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 runbook specified by the identifier.UpdateRunbookVersionResponse
updateRunbookVersion(UpdateRunbookVersionRequest request)
Updates the RunbookVersion.UpdateTaskRecordResponse
updateTaskRecord(UpdateTaskRecordRequest request)
Updates certain attributes for the specified task record.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
-
-
-
-
Constructor Detail
-
FleetAppsManagementRunbooksClient
@Deprecated public FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
FleetAppsManagementRunbooksClient
@Deprecated public FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
FleetAppsManagementRunbooksClient
@Deprecated public FleetAppsManagementRunbooksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFleetAppsManagementRunbooksClient.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 interfaceFleetAppsManagementRunbooks
- 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 callsetEndpoint
.- Specified by:
setRegion
in interfaceFleetAppsManagementRunbooks
- Parameters:
regionId
- The public region ID.
-
changeRunbookCompartment
public ChangeRunbookCompartmentResponse changeRunbookCompartment(ChangeRunbookCompartmentRequest request)
Description copied from interface:FleetAppsManagementRunbooks
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.
- Specified by:
changeRunbookCompartment
in interfaceFleetAppsManagementRunbooks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeTaskRecordCompartment
public ChangeTaskRecordCompartmentResponse changeTaskRecordCompartment(ChangeTaskRecordCompartmentRequest request)
Description copied from interface:FleetAppsManagementRunbooks
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.
- Specified by:
changeTaskRecordCompartment
in interfaceFleetAppsManagementRunbooks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createRunbook
public CreateRunbookResponse createRunbook(CreateRunbookRequest request)
Description copied from interface:FleetAppsManagementRunbooks
Creates a runbook.- Specified by:
createRunbook
in interfaceFleetAppsManagementRunbooks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createRunbookVersion
public CreateRunbookVersionResponse createRunbookVersion(CreateRunbookVersionRequest request)
Description copied from interface:FleetAppsManagementRunbooks
Add RunbookVersion inĀ Fleet Application Management.- Specified by:
createRunbookVersion
in interfaceFleetAppsManagementRunbooks
- 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 record.- Specified by:
createTaskRecord
in interfaceFleetAppsManagementRunbooks
- 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 specified by the identifier.- Specified by:
deleteRunbook
in interfaceFleetAppsManagementRunbooks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteRunbookVersion
public DeleteRunbookVersionResponse deleteRunbookVersion(DeleteRunbookVersionRequest request)
Description copied from interface:FleetAppsManagementRunbooks
Removes a Runbook Version from the runbook in Fleet Application Management.- Specified by:
deleteRunbookVersion
in interfaceFleetAppsManagementRunbooks
- 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 the task record specified by an identifier.- Specified by:
deleteTaskRecord
in interfaceFleetAppsManagementRunbooks
- 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 interfaceFleetAppsManagementRunbooks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRunbookVersion
public GetRunbookVersionResponse getRunbookVersion(GetRunbookVersionRequest request)
Description copied from interface:FleetAppsManagementRunbooks
Gets a Runbook Version by identifier.- Specified by:
getRunbookVersion
in interfaceFleetAppsManagementRunbooks
- 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 information for the specified task record.- Specified by:
getTaskRecord
in interfaceFleetAppsManagementRunbooks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRunbookVersions
public ListRunbookVersionsResponse listRunbookVersions(ListRunbookVersionsRequest request)
Description copied from interface:FleetAppsManagementRunbooks
List versions for a runbook in Fleet Application Management.- Specified by:
listRunbookVersions
in interfaceFleetAppsManagementRunbooks
- 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
Returns a list of all the runbooks in the specified compartment.The query parameter
compartmentId
is required unless the query parameterid
is specified.- Specified by:
listRunbooks
in interfaceFleetAppsManagementRunbooks
- 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 all the task records in the specified compartment.The query parameter
compartmentId
is required unless the query parameterid
is specified.- Specified by:
listTaskRecords
in interfaceFleetAppsManagementRunbooks
- 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 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.
- Specified by:
publishRunbook
in interfaceFleetAppsManagementRunbooks
- 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
Set a runbook as default.- Specified by:
setDefaultRunbook
in interfaceFleetAppsManagementRunbooks
- 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 runbook specified by the identifier.- Specified by:
updateRunbook
in interfaceFleetAppsManagementRunbooks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRunbookVersion
public UpdateRunbookVersionResponse updateRunbookVersion(UpdateRunbookVersionRequest request)
Description copied from interface:FleetAppsManagementRunbooks
Updates the RunbookVersion.- Specified by:
updateRunbookVersion
in interfaceFleetAppsManagementRunbooks
- 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 certain attributes for the specified task record.- Specified by:
updateTaskRecord
in interfaceFleetAppsManagementRunbooks
- 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 interfaceFleetAppsManagementRunbooks
- 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 interfaceFleetAppsManagementRunbooks
- 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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-