@Generated(value="OracleSDKGenerator", comments="API Version: 20220901") public class LifecycleEnvironmentAsyncClient extends BaseAsyncClient implements LifecycleEnvironmentAsync
Async client implementation for LifecycleEnvironment service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response
to the call is an InputStream
, 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
Modifier and Type | Class and Description |
---|---|
static class |
LifecycleEnvironmentAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and 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 LifecycleEnvironment.
|
Constructor and Description |
---|
LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for LifecycleEnvironment.
public final String clientCommonLibraryVersion
@Deprecated public LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see LifecycleEnvironmentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see LifecycleEnvironmentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see LifecycleEnvironmentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see LifecycleEnvironmentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see LifecycleEnvironmentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see LifecycleEnvironmentAsyncClient.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)
@Deprecated public LifecycleEnvironmentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see LifecycleEnvironmentAsyncClient.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
public static LifecycleEnvironmentAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
LifecycleEnvironmentAsync
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.
setRegion
in interface LifecycleEnvironmentAsync
region
- The region of the service.public void setRegion(String regionId)
LifecycleEnvironmentAsync
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
setRegion
in interface LifecycleEnvironmentAsync
regionId
- The public region ID.public Future<AttachManagedInstancesToLifecycleStageResponse> attachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request, AsyncHandler<AttachManagedInstancesToLifecycleStageRequest,AttachManagedInstancesToLifecycleStageResponse> handler)
LifecycleEnvironmentAsync
Attaches (adds) managed instances to a lifecycle stage. Once added, you can apply operations to all managed instances in the lifecycle stage.
attachManagedInstancesToLifecycleStage
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeLifecycleEnvironmentCompartmentResponse> changeLifecycleEnvironmentCompartment(ChangeLifecycleEnvironmentCompartmentRequest request, AsyncHandler<ChangeLifecycleEnvironmentCompartmentRequest,ChangeLifecycleEnvironmentCompartmentResponse> handler)
LifecycleEnvironmentAsync
Moves a lifecycle environment into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeLifecycleEnvironmentCompartment
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateLifecycleEnvironmentResponse> createLifecycleEnvironment(CreateLifecycleEnvironmentRequest request, AsyncHandler<CreateLifecycleEnvironmentRequest,CreateLifecycleEnvironmentResponse> handler)
LifecycleEnvironmentAsync
Creates a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.
createLifecycleEnvironment
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteLifecycleEnvironmentResponse> deleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest request, AsyncHandler<DeleteLifecycleEnvironmentRequest,DeleteLifecycleEnvironmentResponse> handler)
LifecycleEnvironmentAsync
Deletes the specified lifecycle environment.
deleteLifecycleEnvironment
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DetachManagedInstancesFromLifecycleStageResponse> detachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest request, AsyncHandler<DetachManagedInstancesFromLifecycleStageRequest,DetachManagedInstancesFromLifecycleStageResponse> handler)
LifecycleEnvironmentAsync
Detaches (removes) a managed instance from a lifecycle stage.
detachManagedInstancesFromLifecycleStage
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetLifecycleEnvironmentResponse> getLifecycleEnvironment(GetLifecycleEnvironmentRequest request, AsyncHandler<GetLifecycleEnvironmentRequest,GetLifecycleEnvironmentResponse> handler)
LifecycleEnvironmentAsync
Gets information about the specified lifecycle environment.
getLifecycleEnvironment
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetLifecycleStageResponse> getLifecycleStage(GetLifecycleStageRequest request, AsyncHandler<GetLifecycleStageRequest,GetLifecycleStageResponse> handler)
LifecycleEnvironmentAsync
Returns information about the specified lifecycle stage.
getLifecycleStage
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListLifecycleEnvironmentsResponse> listLifecycleEnvironments(ListLifecycleEnvironmentsRequest request, AsyncHandler<ListLifecycleEnvironmentsRequest,ListLifecycleEnvironmentsResponse> handler)
LifecycleEnvironmentAsync
Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.
listLifecycleEnvironments
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListLifecycleStageInstalledPackagesResponse> listLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest request, AsyncHandler<ListLifecycleStageInstalledPackagesRequest,ListLifecycleStageInstalledPackagesResponse> handler)
LifecycleEnvironmentAsync
Lists installed packages on managed instances in a specified lifecycle stage. Filter the list against a variety of criteria including but not limited to the package name.
listLifecycleStageInstalledPackages
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListLifecycleStagesResponse> listLifecycleStages(ListLifecycleStagesRequest request, AsyncHandler<ListLifecycleStagesRequest,ListLifecycleStagesResponse> handler)
LifecycleEnvironmentAsync
Lists lifecycle stages that match the specified compartment or lifecycle stage OCID. Filter the list against
listLifecycleStages
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<PromoteSoftwareSourceToLifecycleStageResponse> promoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request, AsyncHandler<PromoteSoftwareSourceToLifecycleStageRequest,PromoteSoftwareSourceToLifecycleStageResponse> handler)
LifecycleEnvironmentAsync
Updates the versioned custom software source content to the specified lifecycle stage. A versioned custom software source OCID (softwareSourceId) is required when promoting content to the first lifecycle stage. You must promote content to the first stage before promoting to subsequent stages, otherwise the service returns an error. The softwareSourceId is optional when promoting content to the second, third, forth, or fifth stages. If you provide a softwareSourceId, the service validates that it matches the softwareSourceId of the previous stage. If it does not match, the service returns an error. If you don’t provide a softwareSourceId, the service promotes the versioned software source from the previous lifecycle stage. If the previous lifecycle stage has no software source, the service returns an error.
promoteSoftwareSourceToLifecycleStage
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateLifecycleEnvironmentResponse> updateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request, AsyncHandler<UpdateLifecycleEnvironmentRequest,UpdateLifecycleEnvironmentResponse> handler)
LifecycleEnvironmentAsync
Updates the specified lifecycle environment’s name, description, stages, or tags.
updateLifecycleEnvironment
in interface LifecycleEnvironmentAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
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)
Copyright © 2016–2024. All rights reserved.