com.oracle.bmc.stackmonitoring

Class StackMonitoringClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.stackmonitoring.StackMonitoringClient

All Implemented Interfaces:

StackMonitoring, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210330")
public class StackMonitoringClient
extends BaseSyncClient
implements StackMonitoring

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for StackMonitoring.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AssociateMonitoredResourcesResponse	associateMonitoredResources(AssociateMonitoredResourcesRequest request) Create an association between two monitored resources.
static StackMonitoringClient.Builder	builder() Create a builder for this client.
ChangeMonitoredResourceCompartmentResponse	changeMonitoredResourceCompartment(ChangeMonitoredResourceCompartmentRequest request) Moves a monitored resource from one compartment to another.
void	close()
CreateDiscoveryJobResponse	createDiscoveryJob(CreateDiscoveryJobRequest request) API to create discovery Job and submit discovery Details to agent.
CreateMonitoredResourceResponse	createMonitoredResource(CreateMonitoredResourceRequest request) Creates a new monitored resource for the given resource type with the details and submits a work request for promoting the resource to agent.
DeleteDiscoveryJobResponse	deleteDiscoveryJob(DeleteDiscoveryJobRequest request) Deletes a DiscoveryJob by identifier
DeleteMonitoredResourceResponse	deleteMonitoredResource(DeleteMonitoredResourceRequest request) Delete monitored resource by the given identifier OCID.
DisableExternalDatabaseResponse	disableExternalDatabase(DisableExternalDatabaseRequest request) Disable external database resource monitoring.
DisassociateMonitoredResourcesResponse	disassociateMonitoredResources(DisassociateMonitoredResourcesRequest request) Removes associations between two monitored resources.
protected ClientConfigurator	getDefaultConfigurator()
GetDiscoveryJobResponse	getDiscoveryJob(GetDiscoveryJobRequest request) API to get the details of discovery Job by identifier.
String	getEndpoint()
GetMonitoredResourceResponse	getMonitoredResource(GetMonitoredResourceRequest request) Get monitored resource for the given identifier OCID.
StackMonitoringPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
StackMonitoringWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the work request with the given ID.
ListDiscoveryJobLogsResponse	listDiscoveryJobLogs(ListDiscoveryJobLogsRequest request) API to get all the logs of a Discovery Job.
ListDiscoveryJobsResponse	listDiscoveryJobs(ListDiscoveryJobsRequest request) API to get the details of all Discovery Jobs.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Return a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
SearchAssociatedResourcesResponse	searchAssociatedResources(SearchAssociatedResourcesRequest request) List all associated resources recursively up-to a specified level, for the monitored resources of type specified.
SearchMonitoredResourceAssociationsResponse	searchMonitoredResourceAssociations(SearchMonitoredResourceAssociationsRequest request) Search associations in the given compartment based on the search criteria.
SearchMonitoredResourceMembersResponse	searchMonitoredResourceMembers(SearchMonitoredResourceMembersRequest request) List the member resources for the given monitored resource identifier OCID.
SearchMonitoredResourcesResponse	searchMonitoredResources(SearchMonitoredResourcesRequest request) Gets a list of all monitored resources in a compartment for the given search criteria.
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’).
UpdateAndPropagateTagsResponse	updateAndPropagateTags(UpdateAndPropagateTagsRequest request) Provided tags will be added or updated in the existing list of tags for the affected resources.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateMonitoredResourceResponse	updateMonitoredResource(UpdateMonitoredResourceRequest request) Update monitored resource by the given identifier OCID.
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 com.oracle.bmc.stackmonitoring.StackMonitoring

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for StackMonitoring.

Constructor Detail

StackMonitoringClient

@Deprecated
public StackMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

StackMonitoringClient

@Deprecated
public StackMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

StackMonitoringClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

StackMonitoringClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

StackMonitoringClient

@Deprecated
public StackMonitoringClient(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 StackMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

StackMonitoringClient

@Deprecated
public StackMonitoringClient(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 StackMonitoringClient.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)

StackMonitoringClient

@Deprecated
public StackMonitoringClient(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 StackMonitoringClient.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

StackMonitoringClient

@Deprecated
public StackMonitoringClient(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 StackMonitoringClient.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 - StackMonitoringClient.Builder.executorService

Method Detail

builder

public static StackMonitoringClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: StackMonitoring

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 StackMonitoring

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: StackMonitoring

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 StackMonitoring

Parameters:

regionId - The public region ID.

associateMonitoredResources

public AssociateMonitoredResourcesResponse associateMonitoredResources(AssociateMonitoredResourcesRequest request)

Description copied from interface: StackMonitoring

Create an association between two monitored resources. Associations can be created between resources from different compartments as long they are in same tenancy. User should have required access in both the compartments.

Specified by:

associateMonitoredResources in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeMonitoredResourceCompartment

public ChangeMonitoredResourceCompartmentResponse changeMonitoredResourceCompartment(ChangeMonitoredResourceCompartmentRequest request)

Description copied from interface: StackMonitoring

Moves a monitored resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeMonitoredResourceCompartment in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDiscoveryJob

public CreateDiscoveryJobResponse createDiscoveryJob(CreateDiscoveryJobRequest request)

Description copied from interface: StackMonitoring

API to create discovery Job and submit discovery Details to agent.

Specified by:

createDiscoveryJob in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMonitoredResource

public CreateMonitoredResourceResponse createMonitoredResource(CreateMonitoredResourceRequest request)

Description copied from interface: StackMonitoring

Creates a new monitored resource for the given resource type with the details and submits a work request for promoting the resource to agent. Once the resource is successfully added to agent, resource state will be marked active.

Specified by:

createMonitoredResource in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDiscoveryJob

public DeleteDiscoveryJobResponse deleteDiscoveryJob(DeleteDiscoveryJobRequest request)

Description copied from interface: StackMonitoring

Deletes a DiscoveryJob by identifier

Specified by:

deleteDiscoveryJob in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMonitoredResource

public DeleteMonitoredResourceResponse deleteMonitoredResource(DeleteMonitoredResourceRequest request)

Description copied from interface: StackMonitoring

Delete monitored resource by the given identifier OCID. By default, only the specified resource is deleted. If the parameter ‘isDeleteMembers’ is set to true, then the member resources will be deleted too. If the operation fails partially, the deleted entries will not be rolled back.

Specified by:

deleteMonitoredResource in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disableExternalDatabase

public DisableExternalDatabaseResponse disableExternalDatabase(DisableExternalDatabaseRequest request)

Description copied from interface: StackMonitoring

Disable external database resource monitoring. All the references in DBaaS, DBM and resource service will be deleted as part of this operation.

Specified by:

disableExternalDatabase in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disassociateMonitoredResources

public DisassociateMonitoredResourcesResponse disassociateMonitoredResources(DisassociateMonitoredResourcesRequest request)

Description copied from interface: StackMonitoring

Removes associations between two monitored resources.

Specified by:

disassociateMonitoredResources in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDiscoveryJob

public GetDiscoveryJobResponse getDiscoveryJob(GetDiscoveryJobRequest request)

Description copied from interface: StackMonitoring

API to get the details of discovery Job by identifier.

Specified by:

getDiscoveryJob in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMonitoredResource

public GetMonitoredResourceResponse getMonitoredResource(GetMonitoredResourceRequest request)

Description copied from interface: StackMonitoring

Get monitored resource for the given identifier OCID.

Specified by:

getMonitoredResource in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: StackMonitoring

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDiscoveryJobLogs

public ListDiscoveryJobLogsResponse listDiscoveryJobLogs(ListDiscoveryJobLogsRequest request)

Description copied from interface: StackMonitoring

API to get all the logs of a Discovery Job.

Specified by:

listDiscoveryJobLogs in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDiscoveryJobs

public ListDiscoveryJobsResponse listDiscoveryJobs(ListDiscoveryJobsRequest request)

Description copied from interface: StackMonitoring

API to get the details of all Discovery Jobs.

Specified by:

listDiscoveryJobs in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: StackMonitoring

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: StackMonitoring

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: StackMonitoring

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

searchAssociatedResources

public SearchAssociatedResourcesResponse searchAssociatedResources(SearchAssociatedResourcesRequest request)

Description copied from interface: StackMonitoring

List all associated resources recursively up-to a specified level, for the monitored resources of type specified.

Specified by:

searchAssociatedResources in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

searchMonitoredResourceAssociations

public SearchMonitoredResourceAssociationsResponse searchMonitoredResourceAssociations(SearchMonitoredResourceAssociationsRequest request)

Description copied from interface: StackMonitoring

Search associations in the given compartment based on the search criteria.

Specified by:

searchMonitoredResourceAssociations in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

searchMonitoredResourceMembers

public SearchMonitoredResourceMembersResponse searchMonitoredResourceMembers(SearchMonitoredResourceMembersRequest request)

Description copied from interface: StackMonitoring

List the member resources for the given monitored resource identifier OCID.

Specified by:

searchMonitoredResourceMembers in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

searchMonitoredResources

public SearchMonitoredResourcesResponse searchMonitoredResources(SearchMonitoredResourcesRequest request)

Description copied from interface: StackMonitoring

Gets a list of all monitored resources in a compartment for the given search criteria.

Specified by:

searchMonitoredResources in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAndPropagateTags

public UpdateAndPropagateTagsResponse updateAndPropagateTags(UpdateAndPropagateTagsRequest request)

Description copied from interface: StackMonitoring

Provided tags will be added or updated in the existing list of tags for the affected resources. Resources to be updated are identified based on association types specified. If association types not specified, then tags will be updated only for the resource identified by the given monitored resource identifier OCID.

Specified by:

updateAndPropagateTags in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMonitoredResource

public UpdateMonitoredResourceResponse updateMonitoredResource(UpdateMonitoredResourceRequest request)

Description copied from interface: StackMonitoring

Update monitored resource by the given identifier OCID. Note that "properties" object, if specified, will entirely replace the existing object, as part this operation.

Specified by:

updateMonitoredResource in interface StackMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public StackMonitoringWaiters getWaiters()

Description copied from interface: StackMonitoring

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

Specified by:

getWaiters in interface StackMonitoring

Returns:

The service waiters.

getPaginators

public StackMonitoringPaginators getPaginators()

Description copied from interface: StackMonitoring

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 StackMonitoring

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