com.oracle.bmc.stackmonitoring

Interface StackMonitoring

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

StackMonitoringClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210330")
public interface StackMonitoring
extends AutoCloseable

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

Method Summary

Modifier and Type	Method and Description
AssociateMonitoredResourcesResponse	associateMonitoredResources(AssociateMonitoredResourcesRequest request) Create an association between two monitored resources.
ChangeMonitoredResourceCompartmentResponse	changeMonitoredResourceCompartment(ChangeMonitoredResourceCompartmentRequest request) Moves a monitored resource from one compartment to another.
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.
GetDiscoveryJobResponse	getDiscoveryJob(GetDiscoveryJobRequest request) API to get the details of discovery Job by identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
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	refreshClient() Rebuilds the client from scratch.
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) 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’).
UpdateAndPropagateTagsResponse	updateAndPropagateTags(UpdateAndPropagateTagsRequest request) Provided tags will be added or updated in the existing list of tags for the affected resources.
UpdateMonitoredResourceResponse	updateMonitoredResource(UpdateMonitoredResourceRequest request) Update monitored resource by the given identifier OCID.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

associateMonitoredResources

AssociateMonitoredResourcesResponse associateMonitoredResources(AssociateMonitoredResourcesRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 AssociateMonitoredResources API.

changeMonitoredResourceCompartment

ChangeMonitoredResourceCompartmentResponse changeMonitoredResourceCompartment(ChangeMonitoredResourceCompartmentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 ChangeMonitoredResourceCompartment API.

createDiscoveryJob

CreateDiscoveryJobResponse createDiscoveryJob(CreateDiscoveryJobRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 CreateDiscoveryJob API.

createMonitoredResource

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. Once the resource is successfully added to agent, resource state will be marked active.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 CreateMonitoredResource API.

deleteDiscoveryJob

DeleteDiscoveryJobResponse deleteDiscoveryJob(DeleteDiscoveryJobRequest request)

Deletes a DiscoveryJob by identifier

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteDiscoveryJob API.

deleteMonitoredResource

DeleteMonitoredResourceResponse deleteMonitoredResource(DeleteMonitoredResourceRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 DeleteMonitoredResource API.

disableExternalDatabase

DisableExternalDatabaseResponse disableExternalDatabase(DisableExternalDatabaseRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 DisableExternalDatabase API.

disassociateMonitoredResources

DisassociateMonitoredResourcesResponse disassociateMonitoredResources(DisassociateMonitoredResourcesRequest request)

Removes associations between two monitored resources.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 DisassociateMonitoredResources API.

getDiscoveryJob

GetDiscoveryJobResponse getDiscoveryJob(GetDiscoveryJobRequest request)

API to get the details of discovery Job by identifier.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetDiscoveryJob API.

getMonitoredResource

GetMonitoredResourceResponse getMonitoredResource(GetMonitoredResourceRequest request)

Get monitored resource for the given identifier OCID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetMonitoredResource API.

getWorkRequest

GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetWorkRequest API.

listDiscoveryJobLogs

ListDiscoveryJobLogsResponse listDiscoveryJobLogs(ListDiscoveryJobLogsRequest request)

API to get all the logs of a Discovery Job.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListDiscoveryJobLogs API.

listDiscoveryJobs

ListDiscoveryJobsResponse listDiscoveryJobs(ListDiscoveryJobsRequest request)

API to get the details of all Discovery Jobs.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListDiscoveryJobs API.

listWorkRequestErrors

ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequestErrors API.

listWorkRequestLogs

ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequestLogs API.

listWorkRequests

ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Lists the work requests in a compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequests API.

searchAssociatedResources

SearchAssociatedResourcesResponse searchAssociatedResources(SearchAssociatedResourcesRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SearchAssociatedResources API.

searchMonitoredResourceAssociations

SearchMonitoredResourceAssociationsResponse searchMonitoredResourceAssociations(SearchMonitoredResourceAssociationsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SearchMonitoredResourceAssociations API.

searchMonitoredResourceMembers

SearchMonitoredResourceMembersResponse searchMonitoredResourceMembers(SearchMonitoredResourceMembersRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SearchMonitoredResourceMembers API.

searchMonitoredResources

SearchMonitoredResourcesResponse searchMonitoredResources(SearchMonitoredResourcesRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SearchMonitoredResources API.

updateAndPropagateTags

UpdateAndPropagateTagsResponse updateAndPropagateTags(UpdateAndPropagateTagsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateAndPropagateTags API.

updateMonitoredResource

UpdateMonitoredResourceResponse updateMonitoredResource(UpdateMonitoredResourceRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 UpdateMonitoredResource API.

getWaiters

StackMonitoringWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

StackMonitoringPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.