Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OcbAgentSvcClient

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

  • OcbAgentSvcClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

addAgentDependency

  • Add a dependency to the environment. 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 AddAgentDependency API.

    Parameters

    Returns Promise<AddAgentDependencyResponse>

    AddAgentDependencyResponse

changeAgentCompartment

  • Moves an Agent 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 ChangeAgentCompartment API.

    Parameters

    Returns Promise<ChangeAgentCompartmentResponse>

    ChangeAgentCompartmentResponse

changeAgentDependencyCompartment

  • Moves a AgentDependency 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 ChangeAgentDependencyCompartment API.

    Parameters

    Returns Promise<ChangeAgentDependencyCompartmentResponse>

    ChangeAgentDependencyCompartmentResponse

changeEnvironmentCompartment

  • Moves a source environment 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 ChangeEnvironmentCompartment API.

    Parameters

    Returns Promise<ChangeEnvironmentCompartmentResponse>

    ChangeEnvironmentCompartmentResponse

close

  • close(): void

createAgent

  • Creates an Agent.

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

    Parameters

    Returns Promise<CreateAgentResponse>

    CreateAgentResponse

createAgentDependency

createEnvironment

createWaiters

  • Creates a new OcbAgentSvcWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns OcbAgentSvcWaiter

    The service waiters.

deleteAgent

  • Deletes an Agent resource identified by an 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 DeleteAgent API.

    Parameters

    Returns Promise<DeleteAgentResponse>

    DeleteAgentResponse

deleteAgentDependency

deleteEnvironment

  • Deletes a the source environment resource identified by an 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 DeleteEnvironment API.

    Parameters

    Returns Promise<DeleteEnvironmentResponse>

    DeleteEnvironmentResponse

getAgent

  • Gets an Agent 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 GetAgent API.

    Parameters

    Returns Promise<GetAgentResponse>

    GetAgentResponse

getAgentDependency

getEnvironment

  • Gets a source environment 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 GetEnvironment API.

    Parameters

    Returns Promise<GetEnvironmentResponse>

    GetEnvironmentResponse

getPlugin

  • Gets a plugin 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 GetPlugin API.

    Parameters

    Returns Promise<GetPluginResponse>

    GetPluginResponse

getWaiters

listAgentDependencies

  • Returns a list of AgentDependencies such as AgentDependencyCollection.

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

    Parameters

    Returns Promise<ListAgentDependenciesResponse>

    ListAgentDependenciesResponse

listAgents

  • Returns a list of Agents.

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

    Parameters

    Returns Promise<ListAgentsResponse>

    ListAgentsResponse

listApplianceImages

listEnvironments

  • Returns a list of source environments.

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

    Parameters

    Returns Promise<ListEnvironmentsResponse>

    ListEnvironmentsResponse

removeAgentDependency

  • Adds a dependency to the source environment. 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 RemoveAgentDependency API.

    Parameters

    Returns Promise<RemoveAgentDependencyResponse>

    RemoveAgentDependencyResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateAgent

  • Updates the Agent. 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 UpdateAgent API.

    Parameters

    Returns Promise<UpdateAgentResponse>

    UpdateAgentResponse

updateAgentDependency

updateEnvironment

updatePlugin

  • Updates the plugin. 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 UpdatePlugin API.

    Parameters

    Returns Promise<UpdatePluginResponse>

    UpdatePluginResponse