Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContainerEngineClient

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

  • ContainerEngineClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

clusterMigrateToNativeVcn

completeCredentialRotation

createCluster

createKubeconfig

createNodePool

createVirtualNodePool

createWaiters

createWorkloadMapping

deleteCluster

deleteNode

deleteNodePool

deleteVirtualNodePool

deleteWorkRequest

deleteWorkloadMapping

disableAddon

  • Disable addon for a provisioned cluster. 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 DisableAddon API.

    Parameters

    Returns Promise<DisableAddonResponse>

    DisableAddonResponse

getAddon

  • Get the specified addon for a cluster. 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 GetAddon API.

    Parameters

    Returns Promise<GetAddonResponse>

    GetAddonResponse

getCluster

  • Get the details of a cluster. 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 GetCluster API.

    Parameters

    Returns Promise<GetClusterResponse>

    GetClusterResponse

getClusterMigrateToNativeVcnStatus

getClusterOptions

getCredentialRotationStatus

getNodePool

  • Get the details of a node pool. 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 GetNodePool API.

    Parameters

    Returns Promise<GetNodePoolResponse>

    GetNodePoolResponse

getNodePoolOptions

getVirtualNode

getVirtualNodePool

getWaiters

getWorkRequest

getWorkloadMapping

installAddon

  • Install the specified addon for a cluster. 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 InstallAddon API.

    Parameters

    Returns Promise<InstallAddonResponse>

    InstallAddonResponse

listAddonOptions

  • Get list of supported addons for a specific kubernetes version. 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 ListAddonOptions API.

    Parameters

    Returns Promise<ListAddonOptionsResponse>

    ListAddonOptionsResponse

listAddonOptionsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<AddonOptionSummary>

listAddonOptionsResponseIterator

listAddons

  • List addon for a provisioned cluster. 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 ListAddons API.

    Parameters

    Returns Promise<ListAddonsResponse>

    ListAddonsResponse

listAddonsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<AddonSummary>

listAddonsResponseIterator

listAllAddonOptions

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

    Parameters

    Returns AsyncIterableIterator<AddonOptionSummary>

listAllAddonOptionsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListAddonOptionsResponse>

listAllAddons

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

    Parameters

    Returns AsyncIterableIterator<AddonSummary>

listAllAddonsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListAddonsResponse>

listAllClusters

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

    Parameters

    Returns AsyncIterableIterator<ClusterSummary>

listAllClustersResponses

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

    Parameters

    Returns AsyncIterableIterator<ListClustersResponse>

listAllNodePools

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

    Parameters

    Returns AsyncIterableIterator<NodePoolSummary>

listAllNodePoolsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListNodePoolsResponse>

listAllPodShapes

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

    Parameters

    Returns AsyncIterableIterator<PodShapeSummary>

listAllPodShapesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListPodShapesResponse>

listAllVirtualNodePools

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

    Parameters

    Returns AsyncIterableIterator<VirtualNodePoolSummary>

listAllVirtualNodePoolsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVirtualNodePoolsResponse>

listAllVirtualNodes

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

    Parameters

    Returns AsyncIterableIterator<VirtualNodeSummary>

listAllVirtualNodesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVirtualNodesResponse>

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>

listAllWorkloadMappings

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

    Parameters

    Returns AsyncIterableIterator<WorkloadMappingSummary>

listAllWorkloadMappingsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkloadMappingsResponse>

listClusters

  • List all the cluster objects 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 ListClusters API.

    Parameters

    Returns Promise<ListClustersResponse>

    ListClustersResponse

listClustersRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<ClusterSummary>

listClustersResponseIterator

listNodePools

  • List all the node pools in a compartment, and optionally filter by cluster. 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 ListNodePools API.

    Parameters

    Returns Promise<ListNodePoolsResponse>

    ListNodePoolsResponse

listNodePoolsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<NodePoolSummary>

listNodePoolsResponseIterator

listPodShapes

  • List all the Pod Shapes 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 ListPodShapes API.

    Parameters

    Returns Promise<ListPodShapesResponse>

    ListPodShapesResponse

listPodShapesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<PodShapeSummary>

listPodShapesResponseIterator

listVirtualNodePools

  • List all the virtual node pools in a compartment, and optionally filter by cluster. 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 ListVirtualNodePools API.

    Parameters

    Returns Promise<ListVirtualNodePoolsResponse>

    ListVirtualNodePoolsResponse

listVirtualNodePoolsRecordIterator

listVirtualNodePoolsResponseIterator

listVirtualNodes

listVirtualNodesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<VirtualNodeSummary>

listVirtualNodesResponseIterator

listWorkRequestErrors

listWorkRequestLogs

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

listWorkloadMappings

listWorkloadMappingsRecordIterator

listWorkloadMappingsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startCredentialRotation

  • Start cluster credential rotation by adding new credentials, old credentials will still work after this operation. 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 StartCredentialRotation API.

    Parameters

    Returns Promise<StartCredentialRotationResponse>

    StartCredentialRotationResponse

updateAddon

  • Update addon details for a cluster. 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 UpdateAddon API.

    Parameters

    Returns Promise<UpdateAddonResponse>

    UpdateAddonResponse

updateCluster

updateClusterEndpointConfig

updateNodePool

updateVirtualNodePool

updateWorkloadMapping