@Generated(value="OracleSDKGenerator", comments="API Version: 20180917") public interface ResourceManagerAsync extends AutoCloseable
Use the Resource Manager API to automate deployment and operations for all Oracle Cloud Infrastructure resources. Using the infrastructure-as-code (IaC) model, the service is based on Terraform, an open source industry standard that lets DevOps engineers develop and deploy their infrastructure anywhere. For more information, see the Resource Manager documentation.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<CancelJobResponse> cancelJob(CancelJobRequest request, AsyncHandler<CancelJobRequest,CancelJobResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeConfigurationSourceProviderCompartmentResponse> changeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest request, AsyncHandler<ChangeConfigurationSourceProviderCompartmentRequest,ChangeConfigurationSourceProviderCompartmentResponse> handler)
Moves a configuration source provider into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangePrivateEndpointCompartmentResponse> changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request, AsyncHandler<ChangePrivateEndpointCompartmentRequest,ChangePrivateEndpointCompartmentResponse> handler)
Moves a private endpoint to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeStackCompartmentResponse> changeStackCompartment(ChangeStackCompartmentRequest request, AsyncHandler<ChangeStackCompartmentRequest,ChangeStackCompartmentResponse> handler)
Moves a stack (and its associated jobs) into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeTemplateCompartmentResponse> changeTemplateCompartment(ChangeTemplateCompartmentRequest request, AsyncHandler<ChangeTemplateCompartmentRequest,ChangeTemplateCompartmentResponse> handler)
Moves a template into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateConfigurationSourceProviderResponse> createConfigurationSourceProvider(CreateConfigurationSourceProviderRequest request, AsyncHandler<CreateConfigurationSourceProviderRequest,CreateConfigurationSourceProviderResponse> handler)
Creates a configuration source provider in the specified compartment. For more information, see To create a configuration source provider.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateJobResponse> createJob(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResponse> handler)
Creates a job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreatePrivateEndpointResponse> createPrivateEndpoint(CreatePrivateEndpointRequest request, AsyncHandler<CreatePrivateEndpointRequest,CreatePrivateEndpointResponse> handler)
Creates a private endpoint in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateStackResponse> createStack(CreateStackRequest request, AsyncHandler<CreateStackRequest,CreateStackResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateTemplateResponse> createTemplate(CreateTemplateRequest request, AsyncHandler<CreateTemplateRequest,CreateTemplateResponse> handler)
Creates a private template in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteConfigurationSourceProviderResponse> deleteConfigurationSourceProvider(DeleteConfigurationSourceProviderRequest request, AsyncHandler<DeleteConfigurationSourceProviderRequest,DeleteConfigurationSourceProviderResponse> handler)
Deletes the specified configuration source provider.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeletePrivateEndpointResponse> deletePrivateEndpoint(DeletePrivateEndpointRequest request, AsyncHandler<DeletePrivateEndpointRequest,DeletePrivateEndpointResponse> handler)
Deletes the specified private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteStackResponse> deleteStack(DeleteStackRequest request, AsyncHandler<DeleteStackRequest,DeleteStackResponse> handler)
Deletes the specified stack.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest request, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResponse> handler)
Deletes the specified template.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetectStackDriftResponse> detectStackDrift(DetectStackDriftRequest request, AsyncHandler<DetectStackDriftRequest,DetectStackDriftResponse> handler)
Checks drift status for the specified stack.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetConfigurationSourceProviderResponse> getConfigurationSourceProvider(GetConfigurationSourceProviderRequest request, AsyncHandler<GetConfigurationSourceProviderRequest,GetConfigurationSourceProviderResponse> handler)
Gets the properties of the specified configuration source provider.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobResponse> getJob(GetJobRequest request, AsyncHandler<GetJobRequest,GetJobResponse> handler)
Gets the properties of the specified job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobDetailedLogContentResponse> getJobDetailedLogContent(GetJobDetailedLogContentRequest request, AsyncHandler<GetJobDetailedLogContentRequest,GetJobDetailedLogContentResponse> handler)
Returns the Terraform detailed log content for the specified job in plain text. Learn about Terraform detailed log.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobLogsResponse> getJobLogs(GetJobLogsRequest request, AsyncHandler<GetJobLogsRequest,GetJobLogsResponse> handler)
Returns console log entries for the specified job in JSON format.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobLogsContentResponse> getJobLogsContent(GetJobLogsContentRequest request, AsyncHandler<GetJobLogsContentRequest,GetJobLogsContentResponse> handler)
Returns the raw log file for the specified job in text format. The file includes a maximum of 100,000 log entries.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobTfConfigResponse> getJobTfConfig(GetJobTfConfigRequest request, AsyncHandler<GetJobTfConfigRequest,GetJobTfConfigResponse> handler)
Returns the Terraform configuration for the specified job in zip format. If no zip file is found, returns an error.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobTfPlanResponse> getJobTfPlan(GetJobTfPlanRequest request, AsyncHandler<GetJobTfPlanRequest,GetJobTfPlanResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobTfStateResponse> getJobTfState(GetJobTfStateRequest request, AsyncHandler<GetJobTfStateRequest,GetJobTfStateResponse> handler)
Returns the Terraform state for the specified job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetPrivateEndpointResponse> getPrivateEndpoint(GetPrivateEndpointRequest request, AsyncHandler<GetPrivateEndpointRequest,GetPrivateEndpointResponse> handler)
Gets the specified private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetReachableIpResponse> getReachableIp(GetReachableIpRequest request, AsyncHandler<GetReachableIpRequest,GetReachableIpResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetStackResponse> getStack(GetStackRequest request, AsyncHandler<GetStackRequest,GetStackResponse> handler)
Gets the specified stack.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetStackTfConfigResponse> getStackTfConfig(GetStackTfConfigRequest request, AsyncHandler<GetStackTfConfigRequest,GetStackTfConfigResponse> handler)
Returns the Terraform configuration file for the specified stack in zip format. Returns an error if no zip file is found.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetStackTfStateResponse> getStackTfState(GetStackTfStateRequest request, AsyncHandler<GetStackTfStateRequest,GetStackTfStateResponse> handler)
Returns the Terraform state for the specified stack.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTemplateResponse> getTemplate(GetTemplateRequest request, AsyncHandler<GetTemplateRequest,GetTemplateResponse> handler)
Gets the specified template.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTemplateLogoResponse> getTemplateLogo(GetTemplateLogoRequest request, AsyncHandler<GetTemplateLogoRequest,GetTemplateLogoResponse> handler)
Returns the Terraform logo file in .logo format for the specified template. Returns an error if no logo file is found.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTemplateTfConfigResponse> getTemplateTfConfig(GetTemplateTfConfigRequest request, AsyncHandler<GetTemplateTfConfigRequest,GetTemplateTfConfigResponse> handler)
Returns the Terraform configuration file in zip format for the specified template. Returns an error if no zip file is found.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Returns the specified work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListConfigurationSourceProvidersResponse> listConfigurationSourceProviders(ListConfigurationSourceProvidersRequest request, AsyncHandler<ListConfigurationSourceProvidersRequest,ListConfigurationSourceProvidersResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobAssociatedResourcesResponse> listJobAssociatedResources(ListJobAssociatedResourcesRequest request, AsyncHandler<ListJobAssociatedResourcesRequest,ListJobAssociatedResourcesResponse> handler)
Gets the list of resources associated with the specified job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobOutputsResponse> listJobOutputs(ListJobOutputsRequest request, AsyncHandler<ListJobOutputsRequest,ListJobOutputsResponse> handler)
Gets the list of outputs associated with the specified job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobsResponse> listJobs(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResponse> handler)
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 getStack
.)
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListPrivateEndpointsResponse> listPrivateEndpoints(ListPrivateEndpointsRequest request, AsyncHandler<ListPrivateEndpointsRequest,ListPrivateEndpointsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListResourceDiscoveryServicesResponse> listResourceDiscoveryServices(ListResourceDiscoveryServicesRequest request, AsyncHandler<ListResourceDiscoveryServicesRequest,ListResourceDiscoveryServicesResponse> handler)
Returns a list of supported services for Resource Discovery. For reference on service names, see the Terraform provider documentation.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListStackAssociatedResourcesResponse> listStackAssociatedResources(ListStackAssociatedResourcesRequest request, AsyncHandler<ListStackAssociatedResourcesRequest,ListStackAssociatedResourcesResponse> handler)
Gets the list of resources associated with the specified stack.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListStackResourceDriftDetailsResponse> listStackResourceDriftDetails(ListStackResourceDriftDetailsRequest request, AsyncHandler<ListStackResourceDriftDetailsRequest,ListStackResourceDriftDetailsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListStacksResponse> listStacks(ListStacksRequest request, AsyncHandler<ListStacksRequest,ListStacksResponse> handler)
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 getStack
.)
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTemplateCategoriesResponse> listTemplateCategories(ListTemplateCategoriesRequest request, AsyncHandler<ListTemplateCategoriesRequest,ListTemplateCategoriesResponse> handler)
Lists template categories.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTemplatesResponse> listTemplates(ListTemplatesRequest request, AsyncHandler<ListTemplatesRequest,ListTemplatesResponse> handler)
Lists templates according to the specified filter. The attributes compartmentId
and
templateCategoryId
are required unless templateId
is specified.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTerraformVersionsResponse> listTerraformVersions(ListTerraformVersionsRequest request, AsyncHandler<ListTerraformVersionsRequest,ListTerraformVersionsResponse> handler)
Returns a list of supported Terraform versions for use with stacks.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Returns a paginated list of errors for the specified work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Returns a paginated list of logs for the specified work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in the specified compartment or for the specified resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateConfigurationSourceProviderResponse> updateConfigurationSourceProvider(UpdateConfigurationSourceProviderRequest request, AsyncHandler<UpdateConfigurationSourceProviderRequest,UpdateConfigurationSourceProviderResponse> handler)
Updates the properties of the specified configuration source provider. For more information, see To edit a configuration source provider.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateJobResponse> updateJob(UpdateJobRequest request, AsyncHandler<UpdateJobRequest,UpdateJobResponse> handler)
Updates the specified job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdatePrivateEndpointResponse> updatePrivateEndpoint(UpdatePrivateEndpointRequest request, AsyncHandler<UpdatePrivateEndpointRequest,UpdatePrivateEndpointResponse> handler)
Updates the specified private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateStackResponse> updateStack(UpdateStackRequest request, AsyncHandler<UpdateStackRequest,UpdateStackResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest request, AsyncHandler<UpdateTemplateRequest,UpdateTemplateResponse> handler)
Updates the specified template.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.