Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContainerEngineClient

Hierarchy

  • ContainerEngineClient

Constructors

constructor

Properties

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _waiters

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://containerengine.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • set endpoint(endpoint: string): void

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

    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

Methods

createCluster

createKubeconfig

createNodePool

createWaiters

deleteCluster

deleteNodePool

deleteWorkRequest

getCluster

getClusterOptions

getNodePool

getNodePoolOptions

getWaiters

getWorkRequest

listAllClusters

  • 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

listAllNodePools

  • 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

listAllWorkRequests

  • 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

listClusters

listNodePools

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateCluster

updateNodePool