/** * Oracle Cloud Agent API * API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent is a lightweight process that monitors and manages compute instances. * OpenAPI spec version: 20180530 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); import * as requests from "./request"; import * as model from "./model"; import * as responses from "./response"; import { ComputeInstanceAgentWaiter } from "./computeinstanceagent-waiter"; declare const Breaker: any; export declare enum ComputeInstanceAgentApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class ComputeInstanceAgentClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": ComputeInstanceAgentWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _enableDualstackEndpoint: boolean | undefined; protected _serviceUsesDualStackByDefault: boolean; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); set enableDualstackEndpoint(enableDualstackEndpoint: boolean); /** * Creates a new ComputeInstanceAgentWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): ComputeInstanceAgentWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): ComputeInstanceAgentWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Cancels a command that is scheduled to run on a compute instance that is managed * by Oracle Cloud Agent. *

Canceling a command is a best-effort attempt. If the command has already * completed, it will not be canceled. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CancelInstanceAgentCommandRequest * @return CancelInstanceAgentCommandResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/CancelInstanceAgentCommand.ts.html |here} to see how to use CancelInstanceAgentCommand API. */ cancelInstanceAgentCommand(cancelInstanceAgentCommandRequest: requests.CancelInstanceAgentCommandRequest): Promise; /** * Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent. *

On Linux instances, the script runs in a bash shell. On Windows instances, the * script runs in a batch shell. *

Commands that require administrator privileges will run only if Oracle Cloud Agent * is running with administrator privileges. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateInstanceAgentCommandRequest * @return CreateInstanceAgentCommandResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/CreateInstanceAgentCommand.ts.html |here} to see how to use CreateInstanceAgentCommand API. */ createInstanceAgentCommand(createInstanceAgentCommandRequest: requests.CreateInstanceAgentCommandRequest): Promise; /** * Gets information about an Oracle Cloud Agent command. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceAgentCommandRequest * @return GetInstanceAgentCommandResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommand.ts.html |here} to see how to use GetInstanceAgentCommand API. */ getInstanceAgentCommand(getInstanceAgentCommandRequest: requests.GetInstanceAgentCommandRequest): Promise; /** * Gets information about the status of specified instance agent commandId for the given instanceId. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceAgentCommandExecutionRequest * @return GetInstanceAgentCommandExecutionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommandExecution.ts.html |here} to see how to use GetInstanceAgentCommandExecution API. */ getInstanceAgentCommandExecution(getInstanceAgentCommandExecutionRequest: requests.GetInstanceAgentCommandExecutionRequest): Promise; /** * Lists the execution details for Oracle Cloud Agent commands that run on the specified compute * instance. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceAgentCommandExecutionsRequest * @return ListInstanceAgentCommandExecutionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommandExecutions.ts.html |here} to see how to use ListInstanceAgentCommandExecutions API. */ listInstanceAgentCommandExecutions(listInstanceAgentCommandExecutionsRequest: requests.ListInstanceAgentCommandExecutionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceAgentCommandExecutionsRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceAgentCommandExecutionSummary objects * contained in responses from the listInstanceAgentCommandExecutions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceAgentCommandExecutions(request: requests.ListInstanceAgentCommandExecutionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceAgentCommandExecutionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceAgentCommandExecutions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceAgentCommandExecutionsResponses(request: requests.ListInstanceAgentCommandExecutionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceAgentCommandExecutionSummary objects * contained in responses from the listInstanceAgentCommandExecutions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceAgentCommandExecutionsRecordIterator(request: requests.ListInstanceAgentCommandExecutionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceAgentCommandExecutions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceAgentCommandExecutionsResponseIterator(request: requests.ListInstanceAgentCommandExecutionsRequest): AsyncIterableIterator; /** * Lists the Oracle Cloud Agent commands issued in a compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceAgentCommandsRequest * @return ListInstanceAgentCommandsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommands.ts.html |here} to see how to use ListInstanceAgentCommands API. */ listInstanceAgentCommands(listInstanceAgentCommandsRequest: requests.ListInstanceAgentCommandsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceAgentCommandsRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceAgentCommandSummary objects * contained in responses from the listInstanceAgentCommands operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceAgentCommands(request: requests.ListInstanceAgentCommandsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceAgentCommandsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceAgentCommands operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceAgentCommandsResponses(request: requests.ListInstanceAgentCommandsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceAgentCommandSummary objects * contained in responses from the listInstanceAgentCommands operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceAgentCommandsRecordIterator(request: requests.ListInstanceAgentCommandsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceAgentCommands operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceAgentCommandsResponseIterator(request: requests.ListInstanceAgentCommandsRequest): AsyncIterableIterator; } export declare enum PluginApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class PluginClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _enableDualstackEndpoint: boolean | undefined; protected _serviceUsesDualStackByDefault: boolean; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); set enableDualstackEndpoint(enableDualstackEndpoint: boolean); /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Gets information about a specific Oracle Cloud Agent plugin on a compute instance. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceAgentPluginRequest * @return GetInstanceAgentPluginResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/GetInstanceAgentPlugin.ts.html |here} to see how to use GetInstanceAgentPlugin API. */ getInstanceAgentPlugin(getInstanceAgentPluginRequest: requests.GetInstanceAgentPluginRequest): Promise; /** * Gets information about the Oracle Cloud Agent plugins that are available on a specific * compute instance. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceAgentPluginsRequest * @return ListInstanceAgentPluginsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/ListInstanceAgentPlugins.ts.html |here} to see how to use ListInstanceAgentPlugins API. */ listInstanceAgentPlugins(listInstanceAgentPluginsRequest: requests.ListInstanceAgentPluginsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceAgentPluginsRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceAgentPluginSummary objects * contained in responses from the listInstanceAgentPlugins operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceAgentPlugins(request: requests.ListInstanceAgentPluginsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceAgentPluginsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceAgentPlugins operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceAgentPluginsResponses(request: requests.ListInstanceAgentPluginsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceAgentPluginSummary objects * contained in responses from the listInstanceAgentPlugins operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceAgentPluginsRecordIterator(request: requests.ListInstanceAgentPluginsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceAgentPlugins operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceAgentPluginsResponseIterator(request: requests.ListInstanceAgentPluginsRequest): AsyncIterableIterator; } export declare enum PluginconfigApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class PluginconfigClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _enableDualstackEndpoint: boolean | undefined; protected _serviceUsesDualStackByDefault: boolean; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); set enableDualstackEndpoint(enableDualstackEndpoint: boolean); /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Lists the Oracle Cloud Agent plugins that are available for compute instances. * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceagentAvailablePluginsRequest * @return ListInstanceagentAvailablePluginsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/computeinstanceagent/ListInstanceagentAvailablePlugins.ts.html |here} to see how to use ListInstanceagentAvailablePlugins API. */ listInstanceagentAvailablePlugins(listInstanceagentAvailablePluginsRequest: requests.ListInstanceagentAvailablePluginsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceagentAvailablePluginsRecordIterator function. * Creates a new async iterator which will iterate over the models.AvailablePluginSummary objects * contained in responses from the listInstanceagentAvailablePlugins operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceagentAvailablePlugins(request: requests.ListInstanceagentAvailablePluginsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceagentAvailablePluginsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceagentAvailablePlugins operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceagentAvailablePluginsResponses(request: requests.ListInstanceagentAvailablePluginsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.AvailablePluginSummary objects * contained in responses from the listInstanceagentAvailablePlugins operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceagentAvailablePluginsRecordIterator(request: requests.ListInstanceagentAvailablePluginsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceagentAvailablePlugins operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceagentAvailablePluginsResponseIterator(request: requests.ListInstanceagentAvailablePluginsRequest): AsyncIterableIterator; } export {};