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 classResourceManagerClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for ResourceManager.
-
Constructor Summary
Constructors Constructor Description ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResourceManagerClient.Builderbuilder()Create a builder for this client.CancelJobResponsecancelJob(CancelJobRequest request)Indicates the intention to cancel the specified job.ChangeConfigurationSourceProviderCompartmentResponsechangeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest request)Moves a configuration source provider into a different compartment within the same tenancy.ChangePrivateEndpointCompartmentResponsechangePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)Moves a private endpoint to a different compartment within the same tenancy.ChangeStackCompartmentResponsechangeStackCompartment(ChangeStackCompartmentRequest request)Moves a stack (and its associated jobs) into a different compartment within the same tenancy.ChangeTemplateCompartmentResponsechangeTemplateCompartment(ChangeTemplateCompartmentRequest request)Moves a template into a different compartment within the same tenancy.voidclose()CreateConfigurationSourceProviderResponsecreateConfigurationSourceProvider(CreateConfigurationSourceProviderRequest request)Creates a configuration source provider in the specified compartment.CreateJobResponsecreateJob(CreateJobRequest request)Creates a job.CreatePrivateEndpointResponsecreatePrivateEndpoint(CreatePrivateEndpointRequest request)Creates a private endpoint in the specified compartment.CreateStackResponsecreateStack(CreateStackRequest request)Creates a stack in the specified compartment.CreateTemplateResponsecreateTemplate(CreateTemplateRequest request)Creates a private template in the specified compartment.DeleteConfigurationSourceProviderResponsedeleteConfigurationSourceProvider(DeleteConfigurationSourceProviderRequest request)Deletes the specified configuration source provider.DeletePrivateEndpointResponsedeletePrivateEndpoint(DeletePrivateEndpointRequest request)Deletes the specified private endpoint.DeleteStackResponsedeleteStack(DeleteStackRequest request)Deletes the specified stack.DeleteTemplateResponsedeleteTemplate(DeleteTemplateRequest request)Deletes the specified template.DetectStackDriftResponsedetectStackDrift(DetectStackDriftRequest request)Checks drift status for the specified stack.StringgetClientCommonLibraryVersion()GetConfigurationSourceProviderResponsegetConfigurationSourceProvider(GetConfigurationSourceProviderRequest request)Gets the properties of the specified configuration source provider.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()GetJobResponsegetJob(GetJobRequest request)Gets the properties of the specified job.GetJobDetailedLogContentResponsegetJobDetailedLogContent(GetJobDetailedLogContentRequest request)Returns the Terraform detailed log content for the specified job in plain text.GetJobLogsResponsegetJobLogs(GetJobLogsRequest request)Returns console log entries for the specified job in JSON format.GetJobLogsContentResponsegetJobLogsContent(GetJobLogsContentRequest request)Returns the raw log file for the specified job in text format.GetJobTfConfigResponsegetJobTfConfig(GetJobTfConfigRequest request)Returns the Terraform configuration for the specified job in zip format.GetJobTfPlanResponsegetJobTfPlan(GetJobTfPlanRequest request)Returns the output of the specified Terraform plan job in binary or JSON format.GetJobTfStateResponsegetJobTfState(GetJobTfStateRequest request)Returns the Terraform state for the specified job.Optional<String>getMinimumClientCommonLibraryVersionFromClient()ResourceManagerPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPrivateEndpointResponsegetPrivateEndpoint(GetPrivateEndpointRequest request)Gets the specified private endpoint.GetReachableIpResponsegetReachableIp(GetReachableIpRequest request)Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint.GetStackResponsegetStack(GetStackRequest request)Gets the specified stack.GetStackTfConfigResponsegetStackTfConfig(GetStackTfConfigRequest request)Returns the Terraform configuration file for the specified stack in zip format.GetStackTfStateResponsegetStackTfState(GetStackTfStateRequest request)Returns the Terraform state for the specified stack.GetTemplateResponsegetTemplate(GetTemplateRequest request)Gets the specified template.GetTemplateLogoResponsegetTemplateLogo(GetTemplateLogoRequest request)Returns the Terraform logo file in .logo format for the specified template.GetTemplateTfConfigResponsegetTemplateTfConfig(GetTemplateTfConfigRequest request)Returns the Terraform configuration file in zip format for the specified template.ResourceManagerWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Returns the specified work request.ListConfigurationSourceProvidersResponselistConfigurationSourceProviders(ListConfigurationSourceProvidersRequest request)Lists configuration source providers according to the specified filter.ListJobAssociatedResourcesResponselistJobAssociatedResources(ListJobAssociatedResourcesRequest request)Gets the list of resources associated with the specified job.ListJobOutputsResponselistJobOutputs(ListJobOutputsRequest request)Gets the list of outputs associated with the specified job.ListJobsResponselistJobs(ListJobsRequest request)Lists jobs according to the specified filter.ListPrivateEndpointsResponselistPrivateEndpoints(ListPrivateEndpointsRequest request)Lists private endpoints according to the specified filter.ListResourceDiscoveryServicesResponselistResourceDiscoveryServices(ListResourceDiscoveryServicesRequest request)Returns a list of supported services for Resource Discovery.ListStackAssociatedResourcesResponselistStackAssociatedResources(ListStackAssociatedResourcesRequest request)Gets the list of resources associated with the specified stack.ListStackResourceDriftDetailsResponselistStackResourceDriftDetails(ListStackResourceDriftDetailsRequest request)Lists drift status details for each resource defined in the specified stack.ListStacksResponselistStacks(ListStacksRequest request)Lists stacks according to the specified filter.ListTemplateCategoriesResponselistTemplateCategories(ListTemplateCategoriesRequest request)Lists template categories.ListTemplatesResponselistTemplates(ListTemplatesRequest request)Lists templates according to the specified filter.ListTerraformVersionsResponselistTerraformVersions(ListTerraformVersionsRequest request)Returns a list of supported Terraform versions for use with stacks.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Returns a paginated list of errors for the specified work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Returns a paginated list of logs for the specified work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in the specified compartment or for the specified resource.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateConfigurationSourceProviderResponseupdateConfigurationSourceProvider(UpdateConfigurationSourceProviderRequest request)Updates the properties of the specified configuration source provider.UpdateJobResponseupdateJob(UpdateJobRequest request)Updates the specified job.UpdatePrivateEndpointResponseupdatePrivateEndpoint(UpdatePrivateEndpointRequest request)Updates the specified private endpoint.UpdateStackResponseupdateStack(UpdateStackRequest request)Updates the specified stack.UpdateTemplateResponseupdateTemplate(UpdateTemplateRequest request)Updates the specified template.voiduseRealmSpecificEndpointTemplate(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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ResourceManagerClient
@Deprecated public ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeResourceManagerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:ResourceManagerSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceResourceManager- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ResourceManagerSets 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:
setRegionin interfaceResourceManager- Parameters:
regionId- The public region ID.
-
cancelJob
public CancelJobResponse cancelJob(CancelJobRequest request)
Description copied from interface:ResourceManagerIndicates 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
isForcedto 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:
cancelJobin 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:ResourceManagerMoves a configuration source provider into a different compartment within the same tenancy.For more information, see Moving a Configuration Source Provider.
- Specified by:
changeConfigurationSourceProviderCompartmentin 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:ResourceManagerMoves a private endpoint to a different compartment within the same tenancy.For more information, see Moving a Private Endpoint.
- Specified by:
changePrivateEndpointCompartmentin 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:ResourceManagerMoves a stack (and its associated jobs) into a different compartment within the same tenancy.For more information, see Moving a Stack.
- Specified by:
changeStackCompartmentin 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:ResourceManagerMoves a template into a different compartment within the same tenancy.For more information, see Moving a Private Template.
- Specified by:
changeTemplateCompartmentin 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:ResourceManagerCreates a configuration source provider in the specified compartment.For more information, see Creating a Configuration Source Provider.
- Specified by:
createConfigurationSourceProviderin 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:ResourceManagerCreates a job.For more information, see Creating a Job.
- Specified by:
createJobin 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:ResourceManagerCreates a private endpoint in the specified compartment.For more information, see Creating a Private Endpoint.
- Specified by:
createPrivateEndpointin 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:ResourceManagerCreates 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:
createStackin 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:ResourceManagerCreates a private template in the specified compartment.For more information, see Creating a Private Template.
- Specified by:
createTemplatein 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:ResourceManagerDeletes the specified configuration source provider.For more information, see Deleting a Configuration Source Provider.
- Specified by:
deleteConfigurationSourceProviderin 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:ResourceManagerDeletes the specified private endpoint.For more information, see Deleting a Private Endpoint.
- Specified by:
deletePrivateEndpointin 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:ResourceManagerDeletes the specified stack.For more information, see Deleting a Stack.
- Specified by:
deleteStackin 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:ResourceManagerDeletes the specified template.For more information, see Deleting a Private Template.
- Specified by:
deleteTemplatein 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:ResourceManagerChecks drift status for the specified stack.For more information, see Detecting Drift.
- Specified by:
detectStackDriftin 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:ResourceManagerGets the properties of the specified configuration source provider.For more information, see Getting a Configuration Source Provider’s Details.
- Specified by:
getConfigurationSourceProviderin 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:ResourceManagerGets the properties of the specified job.For more information, see Getting a Job’s Details.
- Specified by:
getJobin 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:ResourceManagerReturns 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:
getJobDetailedLogContentin 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:ResourceManagerReturns console log entries for the specified job in JSON format.For more information, see Getting Logs for a Job.
- Specified by:
getJobLogsin 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:ResourceManagerReturns 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:
getJobLogsContentin 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:ResourceManagerReturns 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:
getJobTfConfigin 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:ResourceManagerReturns 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:
getJobTfPlanin 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:ResourceManagerReturns the Terraform state for the specified job.For more information, see Getting a Job Terraform Configuration.
- Specified by:
getJobTfStatein 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:ResourceManagerGets the specified private endpoint.For more information, see Getting a Private Endpoint’s Details.
- Specified by:
getPrivateEndpointin 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:ResourceManagerGets 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:
getReachableIpin 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:ResourceManagerGets the specified stack.For more information, see Getting a Stack’s Details.
- Specified by:
getStackin 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:ResourceManagerReturns 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:
getStackTfConfigin 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:ResourceManagerReturns the Terraform state for the specified stack.For more information, see Getting a Stack State File.
- Specified by:
getStackTfStatein 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:ResourceManagerGets the specified template.For more information, see Getting a Private Template’s Details.
- Specified by:
getTemplatein 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:ResourceManagerReturns 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:
getTemplateLogoin 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:ResourceManagerReturns 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:
getTemplateTfConfigin 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:ResourceManagerReturns the specified work request.For more information, see Getting a Work Request’s Details.
- Specified by:
getWorkRequestin 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:ResourceManagerLists 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:
listConfigurationSourceProvidersin 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:ResourceManagerGets the list of resources associated with the specified job.For more information, see Listing Job Resources.
- Specified by:
listJobAssociatedResourcesin 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:ResourceManagerGets the list of outputs associated with the specified job.For more information, see Listing Job Outputs.
- Specified by:
listJobOutputsin 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:ResourceManagerLists 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:
listJobsin 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:ResourceManagerLists 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:
listPrivateEndpointsin 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:ResourceManagerReturns 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:
listResourceDiscoveryServicesin 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:ResourceManagerGets the list of resources associated with the specified stack.For more information, see Listing Stack Resources.
- Specified by:
listStackAssociatedResourcesin 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:ResourceManagerLists 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:
listStackResourceDriftDetailsin 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:ResourceManagerLists 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:
listStacksin 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:ResourceManagerLists template categories.For more information, see Listing Template Categories.
- Specified by:
listTemplateCategoriesin 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:ResourceManagerLists templates according to the specified filter.The attributes
compartmentIdandtemplateCategoryIdare required unlesstemplateIdis specified. For more information, see Listing Templates.- Specified by:
listTemplatesin 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:ResourceManagerReturns a list of supported Terraform versions for use with stacks.For more information, see Listing Terraform Versions.
- Specified by:
listTerraformVersionsin 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:ResourceManagerReturns a paginated list of errors for the specified work request.For more information, see Listing Errors for a Work Request.
- Specified by:
listWorkRequestErrorsin 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:ResourceManagerReturns a paginated list of logs for the specified work request.For more information, see Listing Logs for a Work Request.
- Specified by:
listWorkRequestLogsin 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:ResourceManagerLists the work requests in the specified compartment or for the specified resource.For more information, see Listing Work Requests.
- Specified by:
listWorkRequestsin 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:ResourceManagerUpdates the properties of the specified configuration source provider.For more information, see Updating a Configuration Source Provider.
- Specified by:
updateConfigurationSourceProviderin 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:ResourceManagerUpdates the specified job.For more information, see Updating a Job.
- Specified by:
updateJobin 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:ResourceManagerUpdates the specified private endpoint.For more information, see Updating a Private Endpoint.
- Specified by:
updatePrivateEndpointin 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:ResourceManagerUpdates the specified stack.Use
UpdateStackwhen 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:
updateStackin 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:ResourceManagerUpdates the specified template.For more information, see Updating a Private Template.
- Specified by:
updateTemplatein 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:ResourceManagerGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceResourceManager- Returns:
- The service waiters.
-
getPaginators
public ResourceManagerPaginators getPaginators()
Description copied from interface:ResourceManagerGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin 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
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-