Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ManagementAgentClient

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

  • ManagementAgentClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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 = "ManagementAgent"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://management-agent.{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

close

  • close(): void

createDataSource

createManagementAgentInstallKey

createWaiters

deleteDataSource

deleteManagementAgent

deleteManagementAgentInstallKey

deleteWorkRequest

deployPlugins

getAutoUpgradableConfig

getDataSource

getManagementAgent

getManagementAgentInstallKey

getManagementAgentInstallKeyContent

getWaiters

getWorkRequest

listAllAvailabilityHistories

  • NOTE: This function is deprecated in favor of listAvailabilityHistoriesRecordIterator function. Creates a new async iterator which will iterate over the models.AvailabilityHistorySummary objects contained in responses from the listAvailabilityHistories operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AvailabilityHistorySummary>

listAllAvailabilityHistoriesResponses

listAllDataSources

  • NOTE: This function is deprecated in favor of listDataSourcesRecordIterator function. Creates a new async iterator which will iterate over the models.DataSourceSummary objects contained in responses from the listDataSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DataSourceSummary>

listAllDataSourcesResponses

  • NOTE: This function is deprecated in favor of listDataSourcesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDataSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDataSourcesResponse>

listAllManagementAgentImages

  • NOTE: This function is deprecated in favor of listManagementAgentImagesRecordIterator function. Creates a new async iterator which will iterate over the models.ManagementAgentImageSummary objects contained in responses from the listManagementAgentImages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ManagementAgentImageSummary>

listAllManagementAgentImagesResponses

listAllManagementAgentInstallKeys

  • NOTE: This function is deprecated in favor of listManagementAgentInstallKeysRecordIterator function. Creates a new async iterator which will iterate over the models.ManagementAgentInstallKeySummary objects contained in responses from the listManagementAgentInstallKeys operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ManagementAgentInstallKeySummary>

listAllManagementAgentInstallKeysResponses

listAllManagementAgentPlugins

  • NOTE: This function is deprecated in favor of listManagementAgentPluginsRecordIterator function. Creates a new async iterator which will iterate over the models.ManagementAgentPluginSummary objects contained in responses from the listManagementAgentPlugins operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ManagementAgentPluginSummary>

listAllManagementAgentPluginsResponses

listAllManagementAgents

  • NOTE: This function is deprecated in favor of listManagementAgentsRecordIterator function. Creates a new async iterator which will iterate over the models.ManagementAgentSummary objects contained in responses from the listManagementAgents operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ManagementAgentSummary>

listAllManagementAgentsResponses

  • NOTE: This function is deprecated in favor of listManagementAgentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listManagementAgents operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListManagementAgentsResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listAvailabilityHistories

listAvailabilityHistoriesRecordIterator

listAvailabilityHistoriesResponseIterator

listDataSources

listDataSourcesRecordIterator

  • Creates a new async iterator which will iterate over the models.DataSourceSummary objects contained in responses from the listDataSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DataSourceSummary>

listDataSourcesResponseIterator

listManagementAgentImages

listManagementAgentImagesRecordIterator

listManagementAgentImagesResponseIterator

listManagementAgentInstallKeys

listManagementAgentInstallKeysRecordIterator

listManagementAgentInstallKeysResponseIterator

listManagementAgentPlugins

listManagementAgentPluginsRecordIterator

listManagementAgentPluginsResponseIterator

listManagementAgents

  • Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.

    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 ListManagementAgents API.

    Parameters

    Returns Promise<ListManagementAgentsResponse>

    ListManagementAgentsResponse

listManagementAgentsRecordIterator

listManagementAgentsResponseIterator

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

listWorkRequestLogsResponseIterator

listWorkRequests

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

setAutoUpgradableConfig

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

summarizeManagementAgentCounts

  • Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version

    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 SummarizeManagementAgentCounts API.

    Parameters

    Returns Promise<SummarizeManagementAgentCountsResponse>

    SummarizeManagementAgentCountsResponse

summarizeManagementAgentPluginCounts

updateDataSource

updateManagementAgent

updateManagementAgentInstallKey