Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResourceManagerClient

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

  • ResourceManagerClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

cancelJob

  • Indicates the intention to cancel the specified job. Cancellation of the job is not immediate, and may be delayed, or may not happen at all. You can optionally choose forced cancellation by setting isForced to true. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources.

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

    Parameters

    Returns Promise<CancelJobResponse>

    CancelJobResponse

changeConfigurationSourceProviderCompartment

changePrivateEndpointCompartment

changeStackCompartment

changeTemplateCompartment

close

  • close(): void

createConfigurationSourceProvider

createJob

  • Creates a job. 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 CreateJob API.

    Parameters

    Returns Promise<CreateJobResponse>

    CreateJobResponse

createPrivateEndpoint

createStack

  • Creates a stack in the specified compartment. You can create a stack from a Terraform configuration. The Terraform configuration can be directly uploaded or referenced from a source code control system. You can also create a stack from an existing compartment, which generates a Terraform configuration. You can also upload the Terraform configuration from an Object Storage bucket. For more information, see Creating Stacks.

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

    Parameters

    Returns Promise<CreateStackResponse>

    CreateStackResponse

createTemplate

  • Creates a private template in the specified 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 CreateTemplate API.

    Parameters

    Returns Promise<CreateTemplateResponse>

    CreateTemplateResponse

createWaiters

deleteConfigurationSourceProvider

deletePrivateEndpoint

deleteStack

  • Deletes the specified stack. 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 DeleteStack API.

    Parameters

    Returns Promise<DeleteStackResponse>

    DeleteStackResponse

deleteTemplate

detectStackDrift

getAllJobLogs

  • NOTE: This function is deprecated in favor of getJobLogsRecordIterator function. 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

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

    Parameters

    Returns AsyncIterableIterator<GetJobLogsResponse>

getConfigurationSourceProvider

getJob

  • Gets the properties of the specified job. 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 GetJob API.

    Parameters

    Returns Promise<GetJobResponse>

    GetJobResponse

getJobDetailedLogContent

getJobLogs

  • Returns console log entries for the specified job in JSON format.

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

    Parameters

    Returns Promise<GetJobLogsResponse>

    GetJobLogsResponse

getJobLogsContent

  • Returns the raw log file for the specified job in text format. The file includes a maximum of 100,000 log entries.

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

    Parameters

    Returns Promise<GetJobLogsContentResponse>

    GetJobLogsContentResponse

getJobLogsRecordIterator

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

getJobLogsResponseIterator

getJobTfConfig

  • Returns the Terraform configuration for the specified job in zip format. If no zip file is found, returns an error.

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

    Parameters

    Returns Promise<GetJobTfConfigResponse>

    GetJobTfConfigResponse

getJobTfPlan

  • Returns the output of the specified Terraform plan job in binary or JSON format. For information about running Terraform plan jobs, see Creating Plan Jobs.

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

    Parameters

    Returns Promise<GetJobTfPlanResponse>

    GetJobTfPlanResponse

getJobTfState

  • Returns the Terraform state for the specified job. 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 GetJobTfState API.

    Parameters

    Returns Promise<GetJobTfStateResponse>

    GetJobTfStateResponse

getPrivateEndpoint

getReachableIp

  • Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint. Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint.

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

    Parameters

    Returns Promise<GetReachableIpResponse>

    GetReachableIpResponse

getStack

  • Gets the specified stack. 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 GetStack API.

    Parameters

    Returns Promise<GetStackResponse>

    GetStackResponse

getStackTfConfig

  • Returns the Terraform configuration file for the specified stack in zip format. Returns an error if no zip file is found.

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

    Parameters

    Returns Promise<GetStackTfConfigResponse>

    GetStackTfConfigResponse

getStackTfState

  • Returns the Terraform state for the specified stack. 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 GetStackTfState API.

    Parameters

    Returns Promise<GetStackTfStateResponse>

    GetStackTfStateResponse

getTemplate

  • Gets the specified template. 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 GetTemplate API.

    Parameters

    Returns Promise<GetTemplateResponse>

    GetTemplateResponse

getTemplateLogo

  • Returns the Terraform logo file in .logo format for the specified template. Returns an error if no logo file is found.

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

    Parameters

    Returns Promise<GetTemplateLogoResponse>

    GetTemplateLogoResponse

getTemplateTfConfig

  • Returns the Terraform configuration file in zip format for the specified template. Returns an error if no zip file is found.

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

    Parameters

    Returns Promise<GetTemplateTfConfigResponse>

    GetTemplateTfConfigResponse

getWaiters

getWorkRequest

listAllJobs

  • NOTE: This function is deprecated in favor of listJobsRecordIterator function. 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

  • NOTE: This function is deprecated in favor of listJobsResponseIterator function. 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

  • NOTE: This function is deprecated in favor of listStacksRecordIterator function. 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

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

    Parameters

    Returns AsyncIterableIterator<ListStacksResponse>

listAllWorkRequestErrors

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

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>

listConfigurationSourceProviders

  • Lists configuration source providers according to the specified filter.

    • For compartmentId, lists all configuration source providers in the matching compartment.
    • For configurationSourceProviderId, lists the matching configuration source provider.

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

    Parameters

    Returns Promise<ListConfigurationSourceProvidersResponse>

    ListConfigurationSourceProvidersResponse

listJobAssociatedResources

listJobOutputs

  • Gets the list of outputs associated with the specified job. 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 ListJobOutputs API.

    Parameters

    Returns Promise<ListJobOutputsResponse>

    ListJobOutputsResponse

listJobs

  • Lists jobs according to the specified filter. By default, the list is 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). (Equivalent to {@link #getStack(GetStackRequest) getStack}.)

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

    Parameters

    Returns Promise<ListJobsResponse>

    ListJobsResponse

listJobsRecordIterator

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

listJobsResponseIterator

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

listPrivateEndpoints

  • Lists private endpoints according to the specified filter.

    • For compartmentId, lists all private endpoints in the matching compartment.
    • For privateEndpointId, lists the matching private endpoint.

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

    Parameters

    Returns Promise<ListPrivateEndpointsResponse>

    ListPrivateEndpointsResponse

listResourceDiscoveryServices

listStackAssociatedResources

listStackResourceDriftDetails

  • Lists drift status details for each resource defined in the specified stack. The drift status details for a given resource indicate differences, if any, between the actual state and the expected (defined) state for that resource. The drift status details correspond to the specified work request (workRequestId). If no work request is specified, then the drift status details correspond to the latest completed work request for the stack.

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

    Parameters

    Returns Promise<ListStackResourceDriftDetailsResponse>

    ListStackResourceDriftDetailsResponse

listStacks

  • Lists stacks according to the specified filter.

    • If called using the compartment ID, returns all stacks in the specified compartment.
    • If called using the stack ID, returns the specified stack. (See also {@link #getStack(GetStackRequest) getStack}.)

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

    Parameters

    Returns Promise<ListStacksResponse>

    ListStacksResponse

listStacksRecordIterator

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

listStacksResponseIterator

listTemplateCategories

listTemplates

  • Lists templates according to the specified filter. The attributes compartmentId and templateCategoryId are required unless templateId is specified.

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

    Parameters

    Returns Promise<ListTemplatesResponse>

    ListTemplatesResponse

listTerraformVersions

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

listWorkRequestLogsResponseIterator

listWorkRequests

  • Lists the work requests in the specified compartment or for the specified 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 ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

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

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateConfigurationSourceProvider

updateJob

  • Updates the specified job. 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 UpdateJob API.

    Parameters

    Returns Promise<UpdateJobResponse>

    UpdateJobResponse

updatePrivateEndpoint

updateStack

  • Updates the specified stack. Use UpdateStack when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see Updating Stacks.

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

    Parameters

    Returns Promise<UpdateStackResponse>

    UpdateStackResponse

updateTemplate