Class ResourceManagerClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.resourcemanager.ResourceManagerClient
-
- All Implemented Interfaces:
ResourceManager
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20180917") public class ResourceManagerClient extends BaseSyncClient implements ResourceManager
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ResourceManagerClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for ResourceManager.
-
Constructor Summary
Constructors Constructor Description ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResourceManagerClient.Builder
builder()
Create a builder for this client.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.void
close()
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.String
getClientCommonLibraryVersion()
GetConfigurationSourceProviderResponse
getConfigurationSourceProvider(GetConfigurationSourceProviderRequest request)
Gets the properties of the specified configuration source provider.protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
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.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.void
setEndpoint(String endpoint)
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’).void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.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 useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.resourcemanager.ResourceManager
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-ResourceManagerClient.Builder.executorService
-
-
Method Detail
-
builder
public static ResourceManagerClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ResourceManager
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.- Specified by:
setRegion
in interfaceResourceManager
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ResourceManager
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceResourceManager
- Parameters:
regionId
- The public region ID.
-
cancelJob
public CancelJobResponse cancelJob(CancelJobRequest request)
Description copied from interface:ResourceManager
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. For more information, see Canceling a Job.- Specified by:
cancelJob
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeConfigurationSourceProviderCompartment
public ChangeConfigurationSourceProviderCompartmentResponse changeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest request)
Description copied from interface:ResourceManager
Moves a configuration source provider into a different compartment within the same tenancy.For more information, see Moving a Configuration Source Provider.
- Specified by:
changeConfigurationSourceProviderCompartment
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changePrivateEndpointCompartment
public ChangePrivateEndpointCompartmentResponse changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)
Description copied from interface:ResourceManager
Moves a private endpoint to a different compartment within the same tenancy.For more information, see Moving a Private Endpoint.
- Specified by:
changePrivateEndpointCompartment
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeStackCompartment
public ChangeStackCompartmentResponse changeStackCompartment(ChangeStackCompartmentRequest request)
Description copied from interface:ResourceManager
Moves a stack (and its associated jobs) into a different compartment within the same tenancy.For more information, see Moving a Stack.
- Specified by:
changeStackCompartment
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeTemplateCompartment
public ChangeTemplateCompartmentResponse changeTemplateCompartment(ChangeTemplateCompartmentRequest request)
Description copied from interface:ResourceManager
Moves a template into a different compartment within the same tenancy.For more information, see Moving a Private Template.
- Specified by:
changeTemplateCompartment
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createConfigurationSourceProvider
public CreateConfigurationSourceProviderResponse createConfigurationSourceProvider(CreateConfigurationSourceProviderRequest request)
Description copied from interface:ResourceManager
Creates a configuration source provider in the specified compartment.For more information, see Creating a Configuration Source Provider.
- Specified by:
createConfigurationSourceProvider
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createJob
public CreateJobResponse createJob(CreateJobRequest request)
Description copied from interface:ResourceManager
Creates a job.For more information, see Creating a Job.
- Specified by:
createJob
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPrivateEndpoint
public CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)
Description copied from interface:ResourceManager
Creates a private endpoint in the specified compartment.For more information, see Creating a Private Endpoint.
- Specified by:
createPrivateEndpoint
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createStack
public CreateStackResponse createStack(CreateStackRequest request)
Description copied from interface:ResourceManager
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 a Stack.
- Specified by:
createStack
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTemplate
public CreateTemplateResponse createTemplate(CreateTemplateRequest request)
Description copied from interface:ResourceManager
Creates a private template in the specified compartment.For more information, see Creating a Private Template.
- Specified by:
createTemplate
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteConfigurationSourceProvider
public DeleteConfigurationSourceProviderResponse deleteConfigurationSourceProvider(DeleteConfigurationSourceProviderRequest request)
Description copied from interface:ResourceManager
Deletes the specified configuration source provider.For more information, see Deleting a Configuration Source Provider.
- Specified by:
deleteConfigurationSourceProvider
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePrivateEndpoint
public DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)
Description copied from interface:ResourceManager
Deletes the specified private endpoint.For more information, see Deleting a Private Endpoint.
- Specified by:
deletePrivateEndpoint
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteStack
public DeleteStackResponse deleteStack(DeleteStackRequest request)
Description copied from interface:ResourceManager
Deletes the specified stack.For more information, see Deleting a Stack.
- Specified by:
deleteStack
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTemplate
public DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest request)
Description copied from interface:ResourceManager
Deletes the specified template.For more information, see Deleting a Private Template.
- Specified by:
deleteTemplate
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detectStackDrift
public DetectStackDriftResponse detectStackDrift(DetectStackDriftRequest request)
Description copied from interface:ResourceManager
Checks drift status for the specified stack.For more information, see Detecting Drift.
- Specified by:
detectStackDrift
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConfigurationSourceProvider
public GetConfigurationSourceProviderResponse getConfigurationSourceProvider(GetConfigurationSourceProviderRequest request)
Description copied from interface:ResourceManager
Gets the properties of the specified configuration source provider.For more information, see Getting a Configuration Source Provider’s Details.
- Specified by:
getConfigurationSourceProvider
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJob
public GetJobResponse getJob(GetJobRequest request)
Description copied from interface:ResourceManager
Gets the properties of the specified job.For more information, see Getting a Job’s Details.
- Specified by:
getJob
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobDetailedLogContent
public GetJobDetailedLogContentResponse getJobDetailedLogContent(GetJobDetailedLogContentRequest request)
Description copied from interface:ResourceManager
Returns the Terraform detailed log content for the specified job in plain text.Learn about Terraform detailed log. For more information, see Getting Detailed Log Content for a Job.
- Specified by:
getJobDetailedLogContent
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobLogs
public GetJobLogsResponse getJobLogs(GetJobLogsRequest request)
Description copied from interface:ResourceManager
Returns console log entries for the specified job in JSON format.For more information, see Getting Logs for a Job.
- Specified by:
getJobLogs
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobLogsContent
public GetJobLogsContentResponse getJobLogsContent(GetJobLogsContentRequest request)
Description copied from interface:ResourceManager
Returns the raw log file for the specified job in text format.The file includes a maximum of 100,000 log entries. For more information, see Getting Logs Content for a Job.
- Specified by:
getJobLogsContent
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobTfConfig
public GetJobTfConfigResponse getJobTfConfig(GetJobTfConfigRequest request)
Description copied from interface:ResourceManager
Returns the Terraform configuration for the specified job in zip format.If no zip file is found, returns an error. For more information, see Getting a Job Terraform Configuration.
- Specified by:
getJobTfConfig
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobTfPlan
public GetJobTfPlanResponse getJobTfPlan(GetJobTfPlanRequest request)
Description copied from interface:ResourceManager
Returns the output of the specified Terraform plan job in binary or JSON format.For more information, see Getting the Terraform Output for a Plan Job.
- Specified by:
getJobTfPlan
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobTfState
public GetJobTfStateResponse getJobTfState(GetJobTfStateRequest request)
Description copied from interface:ResourceManager
Returns the Terraform state for the specified job.For more information, see Getting a Job Terraform Configuration.
- Specified by:
getJobTfState
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPrivateEndpoint
public GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)
Description copied from interface:ResourceManager
Gets the specified private endpoint.For more information, see Getting a Private Endpoint’s Details.
- Specified by:
getPrivateEndpoint
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getReachableIp
public GetReachableIpResponse getReachableIp(GetReachableIpRequest request)
Description copied from interface:ResourceManager
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. For more information, see Getting the Reachable IP Address for a Private Endpoint.
- Specified by:
getReachableIp
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getStack
public GetStackResponse getStack(GetStackRequest request)
Description copied from interface:ResourceManager
Gets the specified stack.For more information, see Getting a Stack’s Details.
- Specified by:
getStack
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getStackTfConfig
public GetStackTfConfigResponse getStackTfConfig(GetStackTfConfigRequest request)
Description copied from interface:ResourceManager
Returns the Terraform configuration file for the specified stack in zip format.Returns an error if no zip file is found. For more information, see Getting a Stack Terraform Configuration.
- Specified by:
getStackTfConfig
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getStackTfState
public GetStackTfStateResponse getStackTfState(GetStackTfStateRequest request)
Description copied from interface:ResourceManager
Returns the Terraform state for the specified stack.For more information, see Getting a Stack State File.
- Specified by:
getStackTfState
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTemplate
public GetTemplateResponse getTemplate(GetTemplateRequest request)
Description copied from interface:ResourceManager
Gets the specified template.For more information, see Getting a Private Template’s Details.
- Specified by:
getTemplate
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTemplateLogo
public GetTemplateLogoResponse getTemplateLogo(GetTemplateLogoRequest request)
Description copied from interface:ResourceManager
Returns the Terraform logo file in .logo format for the specified template.Returns an error if no logo file is found. For more information, see Getting a Private Template’s Logo.
- Specified by:
getTemplateLogo
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTemplateTfConfig
public GetTemplateTfConfigResponse getTemplateTfConfig(GetTemplateTfConfigRequest request)
Description copied from interface:ResourceManager
Returns the Terraform configuration file in zip format for the specified template.Returns an error if no zip file is found. For more information, see Getting a Private Template’s Terraform Configuration.
- Specified by:
getTemplateTfConfig
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:ResourceManager
Returns the specified work request.For more information, see Getting a Work Request’s Details.
- Specified by:
getWorkRequest
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConfigurationSourceProviders
public ListConfigurationSourceProvidersResponse listConfigurationSourceProviders(ListConfigurationSourceProvidersRequest request)
Description copied from interface:ResourceManager
Lists configuration source providers according to the specified filter.For more information, see Listing Configuration Source Providers. - For
compartmentId
, lists all configuration source providers in the matching compartment. - ForconfigurationSourceProviderId
, lists the matching configuration source provider.- Specified by:
listConfigurationSourceProviders
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobAssociatedResources
public ListJobAssociatedResourcesResponse listJobAssociatedResources(ListJobAssociatedResourcesRequest request)
Description copied from interface:ResourceManager
Gets the list of resources associated with the specified job.For more information, see Listing Job Resources.
- Specified by:
listJobAssociatedResources
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobOutputs
public ListJobOutputsResponse listJobOutputs(ListJobOutputsRequest request)
Description copied from interface:ResourceManager
Gets the list of outputs associated with the specified job.For more information, see Listing Job Outputs.
- Specified by:
listJobOutputs
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobs
public ListJobsResponse listJobs(ListJobsRequest request)
Description copied from interface:ResourceManager
Lists jobs according to the specified filter.By default, the list is ordered by time created. For more information, see Listing Jobs.
- To list all jobs in a stack, provide the stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - To list all jobs in a compartment, provide the compartment [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - To return a specific job, provide the job [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). (Equivalent to
getStack
.)- Specified by:
listJobs
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPrivateEndpoints
public ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)
Description copied from interface:ResourceManager
Lists private endpoints according to the specified filter.For more information, see Listing Private Endpoints.
- For
compartmentId
, lists all private endpoints in the matching compartment. - ForprivateEndpointId
, lists the matching private endpoint.
- Specified by:
listPrivateEndpoints
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- For
-
listResourceDiscoveryServices
public ListResourceDiscoveryServicesResponse listResourceDiscoveryServices(ListResourceDiscoveryServicesRequest request)
Description copied from interface:ResourceManager
Returns a list of supported services for Resource Discovery.For reference on service names, see the Terraform provider documentation. For more information, see Listing Resource Discovery Services.
- Specified by:
listResourceDiscoveryServices
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listStackAssociatedResources
public ListStackAssociatedResourcesResponse listStackAssociatedResources(ListStackAssociatedResourcesRequest request)
Description copied from interface:ResourceManager
Gets the list of resources associated with the specified stack.For more information, see Listing Stack Resources.
- Specified by:
listStackAssociatedResources
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listStackResourceDriftDetails
public ListStackResourceDriftDetailsResponse listStackResourceDriftDetails(ListStackResourceDriftDetailsRequest request)
Description copied from interface:ResourceManager
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. For more information, see Listing Drift Status.- Specified by:
listStackResourceDriftDetails
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listStacks
public ListStacksResponse listStacks(ListStacksRequest request)
Description copied from interface:ResourceManager
Lists stacks according to the specified filter.For more information, see Listing Stacks. - 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
.)- Specified by:
listStacks
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTemplateCategories
public ListTemplateCategoriesResponse listTemplateCategories(ListTemplateCategoriesRequest request)
Description copied from interface:ResourceManager
Lists template categories.For more information, see Listing Template Categories.
- Specified by:
listTemplateCategories
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTemplates
public ListTemplatesResponse listTemplates(ListTemplatesRequest request)
Description copied from interface:ResourceManager
Lists templates according to the specified filter.The attributes
compartmentId
andtemplateCategoryId
are required unlesstemplateId
is specified. For more information, see Listing Templates.- Specified by:
listTemplates
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTerraformVersions
public ListTerraformVersionsResponse listTerraformVersions(ListTerraformVersionsRequest request)
Description copied from interface:ResourceManager
Returns a list of supported Terraform versions for use with stacks.For more information, see Listing Terraform Versions.
- Specified by:
listTerraformVersions
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:ResourceManager
Returns a paginated list of errors for the specified work request.For more information, see Listing Errors for a Work Request.
- Specified by:
listWorkRequestErrors
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:ResourceManager
Returns a paginated list of logs for the specified work request.For more information, see Listing Logs for a Work Request.
- Specified by:
listWorkRequestLogs
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:ResourceManager
Lists the work requests in the specified compartment or for the specified resource.For more information, see Listing Work Requests.
- Specified by:
listWorkRequests
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateConfigurationSourceProvider
public UpdateConfigurationSourceProviderResponse updateConfigurationSourceProvider(UpdateConfigurationSourceProviderRequest request)
Description copied from interface:ResourceManager
Updates the properties of the specified configuration source provider.For more information, see Updating a Configuration Source Provider.
- Specified by:
updateConfigurationSourceProvider
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateJob
public UpdateJobResponse updateJob(UpdateJobRequest request)
Description copied from interface:ResourceManager
Updates the specified job.For more information, see Updating a Job.
- Specified by:
updateJob
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePrivateEndpoint
public UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)
Description copied from interface:ResourceManager
Updates the specified private endpoint.For more information, see Updating a Private Endpoint.
- Specified by:
updatePrivateEndpoint
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateStack
public UpdateStackResponse updateStack(UpdateStackRequest request)
Description copied from interface:ResourceManager
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 a Stack.- Specified by:
updateStack
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTemplate
public UpdateTemplateResponse updateTemplate(UpdateTemplateRequest request)
Description copied from interface:ResourceManager
Updates the specified template.For more information, see Updating a Private Template.
- Specified by:
updateTemplate
in interfaceResourceManager
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public ResourceManagerWaiters getWaiters()
Description copied from interface:ResourceManager
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceResourceManager
- Returns:
- The service waiters.
-
getPaginators
public ResourceManagerPaginators getPaginators()
Description copied from interface:ResourceManager
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.- Specified by:
getPaginators
in interfaceResourceManager
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-