Class ResourceManagerAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.resourcemanager.ResourceManagerAsyncClient
-
- All Implemented Interfaces:
ResourceManagerAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20180917") public class ResourceManagerAsyncClient extends BaseAsyncClient implements ResourceManagerAsync
Async client implementation for ResourceManager service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream
, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ResourceManagerAsyncClient.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 ResourceManagerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.ResourceManagerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.ResourceManagerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ResourceManagerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ResourceManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.ResourceManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.ResourceManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
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.ResourceManagerAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ResourceManagerAsyncClient
@Deprecated public ResourceManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
ResourceManagerAsyncClient
@Deprecated public ResourceManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
ResourceManagerAsyncClient
@Deprecated public ResourceManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ResourceManagerAsyncClient
@Deprecated public ResourceManagerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeResourceManagerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
ResourceManagerAsyncClient
@Deprecated public ResourceManagerAsyncClient(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 (seeResourceManagerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
ResourceManagerAsyncClient
@Deprecated public ResourceManagerAsyncClient(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 (seeResourceManagerAsyncClient.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)
-
ResourceManagerAsyncClient
@Deprecated public ResourceManagerAsyncClient(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 (seeResourceManagerAsyncClient.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
-
-
Method Detail
-
builder
public static ResourceManagerAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ResourceManagerAsync
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 interfaceResourceManagerAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ResourceManagerAsync
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 interfaceResourceManagerAsync
- Parameters:
regionId
- The public region ID.
-
cancelJob
public Future<CancelJobResponse> cancelJob(CancelJobRequest request, AsyncHandler<CancelJobRequest,CancelJobResponse> handler)
Description copied from interface:ResourceManagerAsync
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.- Specified by:
cancelJob
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeConfigurationSourceProviderCompartment
public Future<ChangeConfigurationSourceProviderCompartmentResponse> changeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest request, AsyncHandler<ChangeConfigurationSourceProviderCompartmentRequest,ChangeConfigurationSourceProviderCompartmentResponse> handler)
Description copied from interface:ResourceManagerAsync
Moves a configuration source provider into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeConfigurationSourceProviderCompartment
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changePrivateEndpointCompartment
public Future<ChangePrivateEndpointCompartmentResponse> changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request, AsyncHandler<ChangePrivateEndpointCompartmentRequest,ChangePrivateEndpointCompartmentResponse> handler)
Description copied from interface:ResourceManagerAsync
Moves a private endpoint to a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changePrivateEndpointCompartment
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeStackCompartment
public Future<ChangeStackCompartmentResponse> changeStackCompartment(ChangeStackCompartmentRequest request, AsyncHandler<ChangeStackCompartmentRequest,ChangeStackCompartmentResponse> handler)
Description copied from interface:ResourceManagerAsync
Moves a stack (and its associated jobs) into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeStackCompartment
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeTemplateCompartment
public Future<ChangeTemplateCompartmentResponse> changeTemplateCompartment(ChangeTemplateCompartmentRequest request, AsyncHandler<ChangeTemplateCompartmentRequest,ChangeTemplateCompartmentResponse> handler)
Description copied from interface:ResourceManagerAsync
Moves a template into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeTemplateCompartment
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createConfigurationSourceProvider
public Future<CreateConfigurationSourceProviderResponse> createConfigurationSourceProvider(CreateConfigurationSourceProviderRequest request, AsyncHandler<CreateConfigurationSourceProviderRequest,CreateConfigurationSourceProviderResponse> handler)
Description copied from interface:ResourceManagerAsync
Creates a configuration source provider in the specified compartment.For more information, see To create a configuration source provider.
- Specified by:
createConfigurationSourceProvider
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createJob
public Future<CreateJobResponse> createJob(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResponse> handler)
Description copied from interface:ResourceManagerAsync
Creates a job.- Specified by:
createJob
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createPrivateEndpoint
public Future<CreatePrivateEndpointResponse> createPrivateEndpoint(CreatePrivateEndpointRequest request, AsyncHandler<CreatePrivateEndpointRequest,CreatePrivateEndpointResponse> handler)
Description copied from interface:ResourceManagerAsync
Creates a private endpoint in the specified compartment.- Specified by:
createPrivateEndpoint
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createStack
public Future<CreateStackResponse> createStack(CreateStackRequest request, AsyncHandler<CreateStackRequest,CreateStackResponse> handler)
Description copied from interface:ResourceManagerAsync
Creates a stack in the specified compartment.You can create a stack from a Terraform configuration. The Terraform configuration can be directly uploaded or referenced from a source code control system. You can also create a stack from an existing compartment, which generates a Terraform configuration. You can also upload the Terraform configuration from an Object Storage bucket. For more information, see Creating Stacks.
- Specified by:
createStack
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createTemplate
public Future<CreateTemplateResponse> createTemplate(CreateTemplateRequest request, AsyncHandler<CreateTemplateRequest,CreateTemplateResponse> handler)
Description copied from interface:ResourceManagerAsync
Creates a private template in the specified compartment.- Specified by:
createTemplate
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteConfigurationSourceProvider
public Future<DeleteConfigurationSourceProviderResponse> deleteConfigurationSourceProvider(DeleteConfigurationSourceProviderRequest request, AsyncHandler<DeleteConfigurationSourceProviderRequest,DeleteConfigurationSourceProviderResponse> handler)
Description copied from interface:ResourceManagerAsync
Deletes the specified configuration source provider.- Specified by:
deleteConfigurationSourceProvider
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deletePrivateEndpoint
public Future<DeletePrivateEndpointResponse> deletePrivateEndpoint(DeletePrivateEndpointRequest request, AsyncHandler<DeletePrivateEndpointRequest,DeletePrivateEndpointResponse> handler)
Description copied from interface:ResourceManagerAsync
Deletes the specified private endpoint.- Specified by:
deletePrivateEndpoint
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteStack
public Future<DeleteStackResponse> deleteStack(DeleteStackRequest request, AsyncHandler<DeleteStackRequest,DeleteStackResponse> handler)
Description copied from interface:ResourceManagerAsync
Deletes the specified stack.- Specified by:
deleteStack
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteTemplate
public Future<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest request, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResponse> handler)
Description copied from interface:ResourceManagerAsync
Deletes the specified template.- Specified by:
deleteTemplate
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
detectStackDrift
public Future<DetectStackDriftResponse> detectStackDrift(DetectStackDriftRequest request, AsyncHandler<DetectStackDriftRequest,DetectStackDriftResponse> handler)
Description copied from interface:ResourceManagerAsync
Checks drift status for the specified stack.- Specified by:
detectStackDrift
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getConfigurationSourceProvider
public Future<GetConfigurationSourceProviderResponse> getConfigurationSourceProvider(GetConfigurationSourceProviderRequest request, AsyncHandler<GetConfigurationSourceProviderRequest,GetConfigurationSourceProviderResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the properties of the specified configuration source provider.- Specified by:
getConfigurationSourceProvider
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getJob
public Future<GetJobResponse> getJob(GetJobRequest request, AsyncHandler<GetJobRequest,GetJobResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the properties of the specified job.- Specified by:
getJob
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getJobDetailedLogContent
public Future<GetJobDetailedLogContentResponse> getJobDetailedLogContent(GetJobDetailedLogContentRequest request, AsyncHandler<GetJobDetailedLogContentRequest,GetJobDetailedLogContentResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the Terraform detailed log content for the specified job in plain text.- Specified by:
getJobDetailedLogContent
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getJobLogs
public Future<GetJobLogsResponse> getJobLogs(GetJobLogsRequest request, AsyncHandler<GetJobLogsRequest,GetJobLogsResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns console log entries for the specified job in JSON format.- Specified by:
getJobLogs
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getJobLogsContent
public Future<GetJobLogsContentResponse> getJobLogsContent(GetJobLogsContentRequest request, AsyncHandler<GetJobLogsContentRequest,GetJobLogsContentResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the raw log file for the specified job in text format.The file includes a maximum of 100,000 log entries.
- Specified by:
getJobLogsContent
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getJobTfConfig
public Future<GetJobTfConfigResponse> getJobTfConfig(GetJobTfConfigRequest request, AsyncHandler<GetJobTfConfigRequest,GetJobTfConfigResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the Terraform configuration for the specified job in zip format.If no zip file is found, returns an error.
- Specified by:
getJobTfConfig
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getJobTfPlan
public Future<GetJobTfPlanResponse> getJobTfPlan(GetJobTfPlanRequest request, AsyncHandler<GetJobTfPlanRequest,GetJobTfPlanResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the output of the specified Terraform plan job in binary or JSON format.For information about running Terraform plan jobs, see Creating Plan Jobs.
- Specified by:
getJobTfPlan
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getJobTfState
public Future<GetJobTfStateResponse> getJobTfState(GetJobTfStateRequest request, AsyncHandler<GetJobTfStateRequest,GetJobTfStateResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the Terraform state for the specified job.- Specified by:
getJobTfState
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getPrivateEndpoint
public Future<GetPrivateEndpointResponse> getPrivateEndpoint(GetPrivateEndpointRequest request, AsyncHandler<GetPrivateEndpointRequest,GetPrivateEndpointResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the specified private endpoint.- Specified by:
getPrivateEndpoint
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getReachableIp
public Future<GetReachableIpResponse> getReachableIp(GetReachableIpRequest request, AsyncHandler<GetReachableIpRequest,GetReachableIpResponse> handler)
Description copied from interface:ResourceManagerAsync
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.
- Specified by:
getReachableIp
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getStack
public Future<GetStackResponse> getStack(GetStackRequest request, AsyncHandler<GetStackRequest,GetStackResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the specified stack.- Specified by:
getStack
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getStackTfConfig
public Future<GetStackTfConfigResponse> getStackTfConfig(GetStackTfConfigRequest request, AsyncHandler<GetStackTfConfigRequest,GetStackTfConfigResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the Terraform configuration file for the specified stack in zip format.Returns an error if no zip file is found.
- Specified by:
getStackTfConfig
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getStackTfState
public Future<GetStackTfStateResponse> getStackTfState(GetStackTfStateRequest request, AsyncHandler<GetStackTfStateRequest,GetStackTfStateResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the Terraform state for the specified stack.- Specified by:
getStackTfState
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTemplate
public Future<GetTemplateResponse> getTemplate(GetTemplateRequest request, AsyncHandler<GetTemplateRequest,GetTemplateResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the specified template.- Specified by:
getTemplate
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTemplateLogo
public Future<GetTemplateLogoResponse> getTemplateLogo(GetTemplateLogoRequest request, AsyncHandler<GetTemplateLogoRequest,GetTemplateLogoResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the Terraform logo file in .logo format for the specified template.Returns an error if no logo file is found.
- Specified by:
getTemplateLogo
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTemplateTfConfig
public Future<GetTemplateTfConfigResponse> getTemplateTfConfig(GetTemplateTfConfigRequest request, AsyncHandler<GetTemplateTfConfigRequest,GetTemplateTfConfigResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the Terraform configuration file in zip format for the specified template.Returns an error if no zip file is found.
- Specified by:
getTemplateTfConfig
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns the specified work request.- Specified by:
getWorkRequest
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listConfigurationSourceProviders
public Future<ListConfigurationSourceProvidersResponse> listConfigurationSourceProviders(ListConfigurationSourceProvidersRequest request, AsyncHandler<ListConfigurationSourceProvidersRequest,ListConfigurationSourceProvidersResponse> handler)
Description copied from interface:ResourceManagerAsync
Lists configuration source providers according to the specified filter.- For
compartmentId
, lists all configuration source providers in the matching compartment. - ForconfigurationSourceProviderId
, lists the matching configuration source provider.
- Specified by:
listConfigurationSourceProviders
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
- For
-
listJobAssociatedResources
public Future<ListJobAssociatedResourcesResponse> listJobAssociatedResources(ListJobAssociatedResourcesRequest request, AsyncHandler<ListJobAssociatedResourcesRequest,ListJobAssociatedResourcesResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the list of resources associated with the specified job.- Specified by:
listJobAssociatedResources
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listJobOutputs
public Future<ListJobOutputsResponse> listJobOutputs(ListJobOutputsRequest request, AsyncHandler<ListJobOutputsRequest,ListJobOutputsResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the list of outputs associated with the specified job.- Specified by:
listJobOutputs
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listJobs
public Future<ListJobsResponse> listJobs(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResponse> handler)
Description copied from interface:ResourceManagerAsync
Lists jobs according to the specified filter.By default, the list is ordered by time created.
- To list all jobs in a stack, provide the stack [OCID](https://docs.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 interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listPrivateEndpoints
public Future<ListPrivateEndpointsResponse> listPrivateEndpoints(ListPrivateEndpointsRequest request, AsyncHandler<ListPrivateEndpointsRequest,ListPrivateEndpointsResponse> handler)
Description copied from interface:ResourceManagerAsync
Lists private endpoints according to the specified filter.- For
compartmentId
, lists all private endpoints in the matching compartment. - ForprivateEndpointId
, lists the matching private endpoint.
- Specified by:
listPrivateEndpoints
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
- For
-
listResourceDiscoveryServices
public Future<ListResourceDiscoveryServicesResponse> listResourceDiscoveryServices(ListResourceDiscoveryServicesRequest request, AsyncHandler<ListResourceDiscoveryServicesRequest,ListResourceDiscoveryServicesResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns a list of supported services for Resource Discovery.For reference on service names, see the Terraform provider documentation.
- Specified by:
listResourceDiscoveryServices
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listStackAssociatedResources
public Future<ListStackAssociatedResourcesResponse> listStackAssociatedResources(ListStackAssociatedResourcesRequest request, AsyncHandler<ListStackAssociatedResourcesRequest,ListStackAssociatedResourcesResponse> handler)
Description copied from interface:ResourceManagerAsync
Gets the list of resources associated with the specified stack.- Specified by:
listStackAssociatedResources
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listStackResourceDriftDetails
public Future<ListStackResourceDriftDetailsResponse> listStackResourceDriftDetails(ListStackResourceDriftDetailsRequest request, AsyncHandler<ListStackResourceDriftDetailsRequest,ListStackResourceDriftDetailsResponse> handler)
Description copied from interface:ResourceManagerAsync
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.- Specified by:
listStackResourceDriftDetails
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listStacks
public Future<ListStacksResponse> listStacks(ListStacksRequest request, AsyncHandler<ListStacksRequest,ListStacksResponse> handler)
Description copied from interface:ResourceManagerAsync
Lists stacks according to the specified filter.- If called using the compartment ID, returns
all stacks in the specified compartment. - If called using the stack ID, returns the
specified stack. (See also
getStack
.)
- Specified by:
listStacks
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
- 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
-
listTemplateCategories
public Future<ListTemplateCategoriesResponse> listTemplateCategories(ListTemplateCategoriesRequest request, AsyncHandler<ListTemplateCategoriesRequest,ListTemplateCategoriesResponse> handler)
Description copied from interface:ResourceManagerAsync
Lists template categories.- Specified by:
listTemplateCategories
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTemplates
public Future<ListTemplatesResponse> listTemplates(ListTemplatesRequest request, AsyncHandler<ListTemplatesRequest,ListTemplatesResponse> handler)
Description copied from interface:ResourceManagerAsync
Lists templates according to the specified filter.The attributes
compartmentId
andtemplateCategoryId
are required unlesstemplateId
is specified.- Specified by:
listTemplates
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTerraformVersions
public Future<ListTerraformVersionsResponse> listTerraformVersions(ListTerraformVersionsRequest request, AsyncHandler<ListTerraformVersionsRequest,ListTerraformVersionsResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns a list of supported Terraform versions for use with stacks.- Specified by:
listTerraformVersions
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns a paginated list of errors for the specified work request.- Specified by:
listWorkRequestErrors
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:ResourceManagerAsync
Returns a paginated list of logs for the specified work request.- Specified by:
listWorkRequestLogs
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:ResourceManagerAsync
Lists the work requests in the specified compartment or for the specified resource.- Specified by:
listWorkRequests
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateConfigurationSourceProvider
public Future<UpdateConfigurationSourceProviderResponse> updateConfigurationSourceProvider(UpdateConfigurationSourceProviderRequest request, AsyncHandler<UpdateConfigurationSourceProviderRequest,UpdateConfigurationSourceProviderResponse> handler)
Description copied from interface:ResourceManagerAsync
Updates the properties of the specified configuration source provider.For more information, see To edit a configuration source provider.
- Specified by:
updateConfigurationSourceProvider
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateJob
public Future<UpdateJobResponse> updateJob(UpdateJobRequest request, AsyncHandler<UpdateJobRequest,UpdateJobResponse> handler)
Description copied from interface:ResourceManagerAsync
Updates the specified job.- Specified by:
updateJob
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updatePrivateEndpoint
public Future<UpdatePrivateEndpointResponse> updatePrivateEndpoint(UpdatePrivateEndpointRequest request, AsyncHandler<UpdatePrivateEndpointRequest,UpdatePrivateEndpointResponse> handler)
Description copied from interface:ResourceManagerAsync
Updates the specified private endpoint.- Specified by:
updatePrivateEndpoint
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateStack
public Future<UpdateStackResponse> updateStack(UpdateStackRequest request, AsyncHandler<UpdateStackRequest,UpdateStackResponse> handler)
Description copied from interface:ResourceManagerAsync
Updates the specified stack.Use
UpdateStack
when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see Updating Stacks.- Specified by:
updateStack
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateTemplate
public Future<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest request, AsyncHandler<UpdateTemplateRequest,UpdateTemplateResponse> handler)
Description copied from interface:ResourceManagerAsync
Updates the specified template.- Specified by:
updateTemplate
in interfaceResourceManagerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
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()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-