Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResourceManagerClient

Hierarchy

  • ResourceManagerClient

Constructors

constructor

Properties

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _waiters

Static Protected serviceEndpointTemplate

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

cancelJob

changeStackCompartment

createJob

createStack

createWaiters

deleteStack

detectStackDrift

getAllJobLogs

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

    Parameters

    Returns AsyncIterableIterator<LogEntry>

getAllJobLogsResponses

getJob

getJobLogs

getJobLogsContent

getJobTfConfig

getJobTfState

getStack

getStackTfConfig

getStackTfState

getWaiters

getWorkRequest

listAllJobs

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

    Parameters

    • request: ListJobsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<JobSummary>

listAllJobsResponses

  • Creates a new async iterator which will iterate over the responses received from the listJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListJobsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListJobsResponse>

listAllStacks

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

    Parameters

    Returns AsyncIterableIterator<StackSummary>

listAllStacksResponses

listAllWorkRequestErrors

listAllWorkRequestErrorsResponses

listAllWorkRequestLogs

listAllWorkRequestLogsResponses

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

listJobs

  • Returns a list of jobs in a stack or compartment, ordered by time created.

    - To list all jobs in a stack, provide the stack [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - To list all jobs in a compartment, provide the compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - To return a specific job, provide the job [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ListJobsResponse>

    ListJobsResponse

listStackResourceDriftDetails

listStacks

listTerraformVersions

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateJob

updateStack