Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ComputeInstanceAgentClient

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

  • ComputeInstanceAgentClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://iaas.{region}.{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

cancelInstanceAgentCommand

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelInstanceAgentCommand API.

    Parameters

    Returns Promise<CancelInstanceAgentCommandResponse>

    CancelInstanceAgentCommandResponse

close

  • close(): void

createInstanceAgentCommand

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateInstanceAgentCommand API.

    Parameters

    Returns Promise<CreateInstanceAgentCommandResponse>

    CreateInstanceAgentCommandResponse

createWaiters

getInstanceAgentCommand

getInstanceAgentCommandExecution

getWaiters

listAllInstanceAgentCommandExecutions

listAllInstanceAgentCommandExecutionsResponses

listAllInstanceAgentCommands

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

    Parameters

    Returns AsyncIterableIterator<InstanceAgentCommandSummary>

listAllInstanceAgentCommandsResponses

listInstanceAgentCommandExecutions

listInstanceAgentCommandExecutionsRecordIterator

listInstanceAgentCommandExecutionsResponseIterator

listInstanceAgentCommands

listInstanceAgentCommandsRecordIterator

listInstanceAgentCommandsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void