Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StackMonitoringClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • StackMonitoringClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new StackMonitoringClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): StackMonitoringClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "StackMonitoring"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://stack-monitoring.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

associateMonitoredResources

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AssociateMonitoredResources API.

    Parameters

    Returns Promise<AssociateMonitoredResourcesResponse>

    AssociateMonitoredResourcesResponse

changeConfigCompartment

  • Moves the configuration item to another compartment. Basically, this will disable any configuration for this configuration type in thie compartment, and will enable it in the new one.

    For example, if for a HOST resource type, the configuration with AUTO_PROMOTE in the configuration type and TRUE as value is moved, automatic discovery will not take place in this compartment any more, but in the new one.

    So this operation will have the same effect as deleting the configuration item in the old compartment and recreating it in another compartment.

    When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeConfigCompartment API.

    Parameters

    Returns Promise<ChangeConfigCompartmentResponse>

    ChangeConfigCompartmentResponse

changeMetricExtensionCompartment

changeMonitoredResourceCompartment

changeMonitoredResourceTaskCompartment

changeProcessSetCompartment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeProcessSetCompartment API.

    Parameters

    Returns Promise<ChangeProcessSetCompartmentResponse>

    ChangeProcessSetCompartmentResponse

close

  • close(): void

createBaselineableMetric

createConfig

  • Creates a configuration item, for example to define whether resources of a specific type should be discovered automatically.

    For example, when a new Management Agent gets registered in a certain compartment, this Management Agent can potentially get promoted to a HOST resource. The configuration item will determine if HOST resources in the selected compartment will be discovered automatically.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateConfig API.

    Parameters

    Returns Promise<CreateConfigResponse>

    CreateConfigResponse

createDiscoveryJob

createMetricExtension

createMonitoredResource

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateMonitoredResource API.

    Parameters

    Returns Promise<CreateMonitoredResourceResponse>

    CreateMonitoredResourceResponse

createMonitoredResourceTask

createMonitoredResourceType

createProcessSet

createWaiters

deleteBaselineableMetric

deleteConfig

  • Deletes a configuration identified by the id. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteConfig API.

    Parameters

    Returns Promise<DeleteConfigResponse>

    DeleteConfigResponse

deleteDiscoveryJob

deleteMetricExtension

deleteMonitoredResource

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteMonitoredResource API.

    Parameters

    Returns Promise<DeleteMonitoredResourceResponse>

    DeleteMonitoredResourceResponse

deleteMonitoredResourceType

deleteProcessSet

disableExternalDatabase

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DisableExternalDatabase API.

    Parameters

    Returns Promise<DisableExternalDatabaseResponse>

    DisableExternalDatabaseResponse

disableMetricExtension

disassociateMonitoredResources

enableMetricExtension

evaluateBaselineableMetric

exportMetricExtension

  • Export generates a template used to create new metric extension resources similar to matching metric extension id. Response is a file that contains metric extension definition with placeholders for fields to be changed.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ExportMetricExtension API.

    Parameters

    Returns Promise<ExportMetricExtensionResponse>

    ExportMetricExtensionResponse

getBaselineableMetric

getConfig

  • Gets the details of a configuration. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConfig API.

    Parameters

    Returns Promise<GetConfigResponse>

    GetConfigResponse

getDiscoveryJob

  • API to get the details of discovery Job by identifier.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDiscoveryJob API.

    Parameters

    Returns Promise<GetDiscoveryJobResponse>

    GetDiscoveryJobResponse

getMetricExtension

getMonitoredResource

getMonitoredResourceTask

getMonitoredResourceType

getProcessSet

  • API to get the details of a Process Set by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetProcessSet API.

    Parameters

    Returns Promise<GetProcessSetResponse>

    GetProcessSetResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listBaselineableMetrics

listConfigs

  • Get a list of configurations in a compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListConfigs API.

    Parameters

    Returns Promise<ListConfigsResponse>

    ListConfigsResponse

listDiscoveryJobLogs

listDiscoveryJobs

listMetricExtensions

listMonitoredResourceTasks

listMonitoredResourceTypes

  • Returns list of resource types accessible to the customer. There are two types of resource types - System resource types and User resource types. System resource types are available out of the box in the stack monitoring resource service and are accessible to all the tenant users. User resource types are created in the context of a tenancy and are visible only for the tenancy. By default, both System resource types and User resource types are returned.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMonitoredResourceTypes API.

    Parameters

    Returns Promise<ListMonitoredResourceTypesResponse>

    ListMonitoredResourceTypesResponse

listMonitoredResources

listProcessSets

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

manageLicense

  • Each resource is assigned a license based on which features are enabled for it. User is charged differently based on license. Specify the license type to be updated for the parent resource in the topology. The license type value is propagated to the member resources as well. Member resource is a resource which has "contains" association with the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ManageLicense API.

    Parameters

    Returns Promise<ManageLicenseResponse>

    ManageLicenseResponse

publishMetricExtension

requestMonitoredResourcesSummarizedCount

searchAssociatedResources

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SearchAssociatedResources API.

    Parameters

    Returns Promise<SearchAssociatedResourcesResponse>

    SearchAssociatedResourcesResponse

searchMonitoredResourceAssociations

searchMonitoredResourceMembers

searchMonitoredResources

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

testMetricExtension

updateAndPropagateTags

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAndPropagateTags API.

    Parameters

    Returns Promise<UpdateAndPropagateTagsResponse>

    UpdateAndPropagateTagsResponse

updateBaselineableMetric

updateConfig

  • Updates the configuration identified by the id given. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateConfig API.

    Parameters

    Returns Promise<UpdateConfigResponse>

    UpdateConfigResponse

updateMetricExtension

updateMonitoredResource

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateMonitoredResource API.

    Parameters

    Returns Promise<UpdateMonitoredResourceResponse>

    UpdateMonitoredResourceResponse

updateMonitoredResourceTask

updateMonitoredResourceType

updateProcessSet

  • API to update a Process Set identified by a given ocid. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateProcessSet API.

    Parameters

    Returns Promise<UpdateProcessSetResponse>

    UpdateProcessSetResponse