@Generated(value="OracleSDKGenerator", comments="API Version: 20180917") public interface ResourceManager 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.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
CancelJobResponse |
cancelJob(CancelJobRequest request)
Indicates the intention to cancel the specified job.
|
ChangeConfigurationSourceProviderCompartmentResponse |
changeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest request)
Moves a configuration source provider into a different compartment within the same tenancy.
|
ChangePrivateEndpointCompartmentResponse |
changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)
Moves a private endpoint to a different compartment within the same tenancy.
|
ChangeStackCompartmentResponse |
changeStackCompartment(ChangeStackCompartmentRequest request)
Moves a stack (and its associated jobs) into a different compartment within the same tenancy.
|
ChangeTemplateCompartmentResponse |
changeTemplateCompartment(ChangeTemplateCompartmentRequest request)
Moves a template into a different compartment within the same tenancy.
|
CreateConfigurationSourceProviderResponse |
createConfigurationSourceProvider(CreateConfigurationSourceProviderRequest request)
Creates a configuration source provider in the specified compartment.
|
CreateJobResponse |
createJob(CreateJobRequest request)
Creates a job.
|
CreatePrivateEndpointResponse |
createPrivateEndpoint(CreatePrivateEndpointRequest request)
Creates a private endpoint in the specified compartment.
|
CreateStackResponse |
createStack(CreateStackRequest request)
Creates a stack in the specified compartment.
|
CreateTemplateResponse |
createTemplate(CreateTemplateRequest request)
Creates a private template in the specified compartment.
|
DeleteConfigurationSourceProviderResponse |
deleteConfigurationSourceProvider(DeleteConfigurationSourceProviderRequest request)
Deletes the specified configuration source provider.
|
DeletePrivateEndpointResponse |
deletePrivateEndpoint(DeletePrivateEndpointRequest request)
Deletes the specified private endpoint.
|
DeleteStackResponse |
deleteStack(DeleteStackRequest request)
Deletes the specified stack.
|
DeleteTemplateResponse |
deleteTemplate(DeleteTemplateRequest request)
Deletes the specified template.
|
DetectStackDriftResponse |
detectStackDrift(DetectStackDriftRequest request)
Checks drift status for the specified stack.
|
GetConfigurationSourceProviderResponse |
getConfigurationSourceProvider(GetConfigurationSourceProviderRequest request)
Gets the properties of the specified configuration source provider.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetJobResponse |
getJob(GetJobRequest request)
Gets the properties of the specified job.
|
GetJobDetailedLogContentResponse |
getJobDetailedLogContent(GetJobDetailedLogContentRequest request)
Returns the Terraform detailed log content for the specified job in plain text.
|
GetJobLogsResponse |
getJobLogs(GetJobLogsRequest request)
Returns console log entries for the specified job in JSON format.
|
GetJobLogsContentResponse |
getJobLogsContent(GetJobLogsContentRequest request)
Returns the raw log file for the specified job in text format.
|
GetJobTfConfigResponse |
getJobTfConfig(GetJobTfConfigRequest request)
Returns the Terraform configuration for the specified job in zip format.
|
GetJobTfPlanResponse |
getJobTfPlan(GetJobTfPlanRequest request)
Returns the output of the specified Terraform plan job in binary or JSON format.
|
GetJobTfStateResponse |
getJobTfState(GetJobTfStateRequest request)
Returns the Terraform state for the specified job.
|
ResourceManagerPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetPrivateEndpointResponse |
getPrivateEndpoint(GetPrivateEndpointRequest request)
Gets the specified private endpoint.
|
GetReachableIpResponse |
getReachableIp(GetReachableIpRequest request)
Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated
with the private endpoint.
|
GetStackResponse |
getStack(GetStackRequest request)
Gets the specified stack.
|
GetStackTfConfigResponse |
getStackTfConfig(GetStackTfConfigRequest request)
Returns the Terraform configuration file for the specified stack in zip format.
|
GetStackTfStateResponse |
getStackTfState(GetStackTfStateRequest request)
Returns the Terraform state for the specified stack.
|
GetTemplateResponse |
getTemplate(GetTemplateRequest request)
Gets the specified template.
|
GetTemplateLogoResponse |
getTemplateLogo(GetTemplateLogoRequest request)
Returns the Terraform logo file in .logo format for the specified template.
|
GetTemplateTfConfigResponse |
getTemplateTfConfig(GetTemplateTfConfigRequest request)
Returns the Terraform configuration file in zip format for the specified template.
|
ResourceManagerWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Returns the specified work request.
|
ListConfigurationSourceProvidersResponse |
listConfigurationSourceProviders(ListConfigurationSourceProvidersRequest request)
Lists configuration source providers according to the specified filter.
|
ListJobAssociatedResourcesResponse |
listJobAssociatedResources(ListJobAssociatedResourcesRequest request)
Gets the list of resources associated with the specified job.
|
ListJobOutputsResponse |
listJobOutputs(ListJobOutputsRequest request)
Gets the list of outputs associated with the specified job.
|
ListJobsResponse |
listJobs(ListJobsRequest request)
Lists jobs according to the specified filter.
|
ListPrivateEndpointsResponse |
listPrivateEndpoints(ListPrivateEndpointsRequest request)
Lists private endpoints according to the specified filter.
|
ListResourceDiscoveryServicesResponse |
listResourceDiscoveryServices(ListResourceDiscoveryServicesRequest request)
Returns a list of supported services for Resource
Discovery.
|
ListStackAssociatedResourcesResponse |
listStackAssociatedResources(ListStackAssociatedResourcesRequest request)
Gets the list of resources associated with the specified stack.
|
ListStackResourceDriftDetailsResponse |
listStackResourceDriftDetails(ListStackResourceDriftDetailsRequest request)
Lists drift status details for each resource defined in the specified stack.
|
ListStacksResponse |
listStacks(ListStacksRequest request)
Lists stacks according to the specified filter.
|
ListTemplateCategoriesResponse |
listTemplateCategories(ListTemplateCategoriesRequest request)
Lists template categories.
|
ListTemplatesResponse |
listTemplates(ListTemplatesRequest request)
Lists templates according to the specified filter.
|
ListTerraformVersionsResponse |
listTerraformVersions(ListTerraformVersionsRequest request)
Returns a list of supported Terraform versions for use with stacks.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a paginated list of errors for the specified work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a paginated list of logs for the specified work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in the specified compartment or for the specified resource.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateConfigurationSourceProviderResponse |
updateConfigurationSourceProvider(UpdateConfigurationSourceProviderRequest request)
Updates the properties of the specified configuration source provider.
|
UpdateJobResponse |
updateJob(UpdateJobRequest request)
Updates the specified job.
|
UpdatePrivateEndpointResponse |
updatePrivateEndpoint(UpdatePrivateEndpointRequest request)
Updates the specified private endpoint.
|
UpdateStackResponse |
updateStack(UpdateStackRequest request)
Updates the specified stack.
|
UpdateTemplateResponse |
updateTemplate(UpdateTemplateRequest request)
Updates the specified template.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
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 service.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
templateCancelJobResponse cancelJob(CancelJobRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelJob API.
ChangeConfigurationSourceProviderCompartmentResponse changeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeConfigurationSourceProviderCompartment API.
ChangePrivateEndpointCompartmentResponse changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangePrivateEndpointCompartment API.
ChangeStackCompartmentResponse changeStackCompartment(ChangeStackCompartmentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeStackCompartment API.
ChangeTemplateCompartmentResponse changeTemplateCompartment(ChangeTemplateCompartmentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeTemplateCompartment API.
CreateConfigurationSourceProviderResponse createConfigurationSourceProvider(CreateConfigurationSourceProviderRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateConfigurationSourceProvider API.
CreateJobResponse createJob(CreateJobRequest request)
Creates a job.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateJob API.
CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)
Creates a private endpoint in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreatePrivateEndpoint API.
CreateStackResponse createStack(CreateStackRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateStack API.
CreateTemplateResponse createTemplate(CreateTemplateRequest request)
Creates a private template in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTemplate API.
DeleteConfigurationSourceProviderResponse deleteConfigurationSourceProvider(DeleteConfigurationSourceProviderRequest request)
Deletes the specified configuration source provider.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteConfigurationSourceProvider API.
DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)
Deletes the specified private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeletePrivateEndpoint API.
DeleteStackResponse deleteStack(DeleteStackRequest request)
Deletes the specified stack.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteStack API.
DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest request)
Deletes the specified template.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteTemplate API.
DetectStackDriftResponse detectStackDrift(DetectStackDriftRequest request)
Checks drift status for the specified stack.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DetectStackDrift API.
GetConfigurationSourceProviderResponse getConfigurationSourceProvider(GetConfigurationSourceProviderRequest request)
Gets the properties of the specified configuration source provider.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetConfigurationSourceProvider API.
GetJobResponse getJob(GetJobRequest request)
Gets the properties of the specified job.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJob API.
GetJobDetailedLogContentResponse getJobDetailedLogContent(GetJobDetailedLogContentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobDetailedLogContent API.
GetJobLogsResponse getJobLogs(GetJobLogsRequest request)
Returns console log entries for the specified job in JSON format.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobLogs API.
GetJobLogsContentResponse getJobLogsContent(GetJobLogsContentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobLogsContent API.
GetJobTfConfigResponse getJobTfConfig(GetJobTfConfigRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobTfConfig API.
GetJobTfPlanResponse getJobTfPlan(GetJobTfPlanRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobTfPlan API.
GetJobTfStateResponse getJobTfState(GetJobTfStateRequest request)
Returns the Terraform state for the specified job.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobTfState API.
GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)
Gets the specified private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetPrivateEndpoint API.
GetReachableIpResponse getReachableIp(GetReachableIpRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetReachableIp API.
GetStackResponse getStack(GetStackRequest request)
Gets the specified stack.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetStack API.
GetStackTfConfigResponse getStackTfConfig(GetStackTfConfigRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetStackTfConfig API.
GetStackTfStateResponse getStackTfState(GetStackTfStateRequest request)
Returns the Terraform state for the specified stack.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetStackTfState API.
GetTemplateResponse getTemplate(GetTemplateRequest request)
Gets the specified template.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTemplate API.
GetTemplateLogoResponse getTemplateLogo(GetTemplateLogoRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTemplateLogo API.
GetTemplateTfConfigResponse getTemplateTfConfig(GetTemplateTfConfigRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTemplateTfConfig API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Returns the specified work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWorkRequest API.
ListConfigurationSourceProvidersResponse listConfigurationSourceProviders(ListConfigurationSourceProvidersRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListConfigurationSourceProviders API.
ListJobAssociatedResourcesResponse listJobAssociatedResources(ListJobAssociatedResourcesRequest request)
Gets the list of resources associated with the specified job.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListJobAssociatedResources API.
ListJobOutputsResponse listJobOutputs(ListJobOutputsRequest request)
Gets the list of outputs associated with the specified job.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListJobOutputs API.
ListJobsResponse listJobs(ListJobsRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListJobs API.
ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListPrivateEndpoints API.
ListResourceDiscoveryServicesResponse listResourceDiscoveryServices(ListResourceDiscoveryServicesRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourceDiscoveryServices API.
ListStackAssociatedResourcesResponse listStackAssociatedResources(ListStackAssociatedResourcesRequest request)
Gets the list of resources associated with the specified stack.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListStackAssociatedResources API.
ListStackResourceDriftDetailsResponse listStackResourceDriftDetails(ListStackResourceDriftDetailsRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListStackResourceDriftDetails API.
ListStacksResponse listStacks(ListStacksRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListStacks API.
ListTemplateCategoriesResponse listTemplateCategories(ListTemplateCategoriesRequest request)
Lists template categories.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTemplateCategories API.
ListTemplatesResponse listTemplates(ListTemplatesRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTemplates API.
ListTerraformVersionsResponse listTerraformVersions(ListTerraformVersionsRequest request)
Returns a list of supported Terraform versions for use with stacks.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTerraformVersions API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a paginated list of errors for the specified work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a paginated list of logs for the specified work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in the specified compartment or for the specified resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequests API.
UpdateConfigurationSourceProviderResponse updateConfigurationSourceProvider(UpdateConfigurationSourceProviderRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateConfigurationSourceProvider API.
UpdateJobResponse updateJob(UpdateJobRequest request)
Updates the specified job.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateJob API.
UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)
Updates the specified private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdatePrivateEndpoint API.
UpdateStackResponse updateStack(UpdateStackRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateStack API.
UpdateTemplateResponse updateTemplate(UpdateTemplateRequest request)
Updates the specified template.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTemplate API.
ResourceManagerWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
ResourceManagerPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
Copyright © 2016–2024. All rights reserved.