Class ArtifactsAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.artifacts.ArtifactsAsyncClient
-
- All Implemented Interfaces:
ArtifactsAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ArtifactsAsyncClient extends BaseAsyncClient implements ArtifactsAsync
Async client implementation for Artifacts 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
ArtifactsAsyncClient.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 Artifacts.
-
Constructor Summary
Constructors Constructor Description ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.ArtifactsAsyncClient(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 com.oracle.bmc.artifacts.ArtifactsAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Constructor Detail
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(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 (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(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 (seeArtifactsAsyncClient.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)
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(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 (seeArtifactsAsyncClient.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 ArtifactsAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ArtifactsAsync
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 interfaceArtifactsAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ArtifactsAsync
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 interfaceArtifactsAsync
- Parameters:
regionId
- The public region ID.
-
changeContainerRepositoryCompartment
public Future<ChangeContainerRepositoryCompartmentResponse> changeContainerRepositoryCompartment(ChangeContainerRepositoryCompartmentRequest request, AsyncHandler<ChangeContainerRepositoryCompartmentRequest,ChangeContainerRepositoryCompartmentResponse> handler)
Description copied from interface:ArtifactsAsync
Moves a container repository into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeContainerRepositoryCompartment
in interfaceArtifactsAsync
- 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.
-
changeRepositoryCompartment
public Future<ChangeRepositoryCompartmentResponse> changeRepositoryCompartment(ChangeRepositoryCompartmentRequest request, AsyncHandler<ChangeRepositoryCompartmentRequest,ChangeRepositoryCompartmentResponse> handler)
Description copied from interface:ArtifactsAsync
Moves a repository into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeRepositoryCompartment
in interfaceArtifactsAsync
- 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.
-
createContainerImageSignature
public Future<CreateContainerImageSignatureResponse> createContainerImageSignature(CreateContainerImageSignatureRequest request, AsyncHandler<CreateContainerImageSignatureRequest,CreateContainerImageSignatureResponse> handler)
Description copied from interface:ArtifactsAsync
Upload a signature to an image.- Specified by:
createContainerImageSignature
in interfaceArtifactsAsync
- 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.
-
createContainerRepository
public Future<CreateContainerRepositoryResponse> createContainerRepository(CreateContainerRepositoryRequest request, AsyncHandler<CreateContainerRepositoryRequest,CreateContainerRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Create a new empty container repository.Avoid entering confidential information.
- Specified by:
createContainerRepository
in interfaceArtifactsAsync
- 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.
-
createRepository
public Future<CreateRepositoryResponse> createRepository(CreateRepositoryRequest request, AsyncHandler<CreateRepositoryRequest,CreateRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Creates a new repository for storing artifacts.- Specified by:
createRepository
in interfaceArtifactsAsync
- 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.
-
deleteContainerImage
public Future<DeleteContainerImageResponse> deleteContainerImage(DeleteContainerImageRequest request, AsyncHandler<DeleteContainerImageRequest,DeleteContainerImageResponse> handler)
Description copied from interface:ArtifactsAsync
Delete a container image.- Specified by:
deleteContainerImage
in interfaceArtifactsAsync
- 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.
-
deleteContainerImageSignature
public Future<DeleteContainerImageSignatureResponse> deleteContainerImageSignature(DeleteContainerImageSignatureRequest request, AsyncHandler<DeleteContainerImageSignatureRequest,DeleteContainerImageSignatureResponse> handler)
Description copied from interface:ArtifactsAsync
Delete a container image signature.- Specified by:
deleteContainerImageSignature
in interfaceArtifactsAsync
- 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.
-
deleteContainerRepository
public Future<DeleteContainerRepositoryResponse> deleteContainerRepository(DeleteContainerRepositoryRequest request, AsyncHandler<DeleteContainerRepositoryRequest,DeleteContainerRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Delete container repository.- Specified by:
deleteContainerRepository
in interfaceArtifactsAsync
- 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.
-
deleteGenericArtifact
public Future<DeleteGenericArtifactResponse> deleteGenericArtifact(DeleteGenericArtifactRequest request, AsyncHandler<DeleteGenericArtifactRequest,DeleteGenericArtifactResponse> handler)
Description copied from interface:ArtifactsAsync
Deletes an artifact with a specified OCID.- Specified by:
deleteGenericArtifact
in interfaceArtifactsAsync
- 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.
-
deleteGenericArtifactByPath
public Future<DeleteGenericArtifactByPathResponse> deleteGenericArtifactByPath(DeleteGenericArtifactByPathRequest request, AsyncHandler<DeleteGenericArtifactByPathRequest,DeleteGenericArtifactByPathResponse> handler)
Description copied from interface:ArtifactsAsync
Deletes an artifact with a specifiedartifactPath
andversion
.- Specified by:
deleteGenericArtifactByPath
in interfaceArtifactsAsync
- 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.
-
deleteRepository
public Future<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest request, AsyncHandler<DeleteRepositoryRequest,DeleteRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Deletes the specified repository.This operation fails unless all associated artifacts are in a DELETED state. You must delete all associated artifacts before deleting a repository.
- Specified by:
deleteRepository
in interfaceArtifactsAsync
- 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.
-
getContainerConfiguration
public Future<GetContainerConfigurationResponse> getContainerConfiguration(GetContainerConfigurationRequest request, AsyncHandler<GetContainerConfigurationRequest,GetContainerConfigurationResponse> handler)
Description copied from interface:ArtifactsAsync
Get container configuration.- Specified by:
getContainerConfiguration
in interfaceArtifactsAsync
- 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.
-
getContainerImage
public Future<GetContainerImageResponse> getContainerImage(GetContainerImageRequest request, AsyncHandler<GetContainerImageRequest,GetContainerImageResponse> handler)
Description copied from interface:ArtifactsAsync
Get container image metadata.- Specified by:
getContainerImage
in interfaceArtifactsAsync
- 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.
-
getContainerImageSignature
public Future<GetContainerImageSignatureResponse> getContainerImageSignature(GetContainerImageSignatureRequest request, AsyncHandler<GetContainerImageSignatureRequest,GetContainerImageSignatureResponse> handler)
Description copied from interface:ArtifactsAsync
Get container image signature metadata.- Specified by:
getContainerImageSignature
in interfaceArtifactsAsync
- 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.
-
getContainerRepository
public Future<GetContainerRepositoryResponse> getContainerRepository(GetContainerRepositoryRequest request, AsyncHandler<GetContainerRepositoryRequest,GetContainerRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Get container repository.- Specified by:
getContainerRepository
in interfaceArtifactsAsync
- 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.
-
getGenericArtifact
public Future<GetGenericArtifactResponse> getGenericArtifact(GetGenericArtifactRequest request, AsyncHandler<GetGenericArtifactRequest,GetGenericArtifactResponse> handler)
Description copied from interface:ArtifactsAsync
Gets information about an artifact with a specified OCID.- Specified by:
getGenericArtifact
in interfaceArtifactsAsync
- 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.
-
getGenericArtifactByPath
public Future<GetGenericArtifactByPathResponse> getGenericArtifactByPath(GetGenericArtifactByPathRequest request, AsyncHandler<GetGenericArtifactByPathRequest,GetGenericArtifactByPathResponse> handler)
Description copied from interface:ArtifactsAsync
Gets information about an artifact with a specifiedartifactPath
andversion
.- Specified by:
getGenericArtifactByPath
in interfaceArtifactsAsync
- 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.
-
getRepository
public Future<GetRepositoryResponse> getRepository(GetRepositoryRequest request, AsyncHandler<GetRepositoryRequest,GetRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Gets the specified repository’s information.- Specified by:
getRepository
in interfaceArtifactsAsync
- 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.
-
listContainerImageSignatures
public Future<ListContainerImageSignaturesResponse> listContainerImageSignatures(ListContainerImageSignaturesRequest request, AsyncHandler<ListContainerImageSignaturesRequest,ListContainerImageSignaturesResponse> handler)
Description copied from interface:ArtifactsAsync
List container image signatures in an image.- Specified by:
listContainerImageSignatures
in interfaceArtifactsAsync
- 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.
-
listContainerImages
public Future<ListContainerImagesResponse> listContainerImages(ListContainerImagesRequest request, AsyncHandler<ListContainerImagesRequest,ListContainerImagesResponse> handler)
Description copied from interface:ArtifactsAsync
List container images in a compartment.- Specified by:
listContainerImages
in interfaceArtifactsAsync
- 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.
-
listContainerRepositories
public Future<ListContainerRepositoriesResponse> listContainerRepositories(ListContainerRepositoriesRequest request, AsyncHandler<ListContainerRepositoriesRequest,ListContainerRepositoriesResponse> handler)
Description copied from interface:ArtifactsAsync
List container repositories in a compartment.- Specified by:
listContainerRepositories
in interfaceArtifactsAsync
- 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.
-
listGenericArtifacts
public Future<ListGenericArtifactsResponse> listGenericArtifacts(ListGenericArtifactsRequest request, AsyncHandler<ListGenericArtifactsRequest,ListGenericArtifactsResponse> handler)
Description copied from interface:ArtifactsAsync
Lists artifacts in the specified repository.- Specified by:
listGenericArtifacts
in interfaceArtifactsAsync
- 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.
-
listRepositories
public Future<ListRepositoriesResponse> listRepositories(ListRepositoriesRequest request, AsyncHandler<ListRepositoriesRequest,ListRepositoriesResponse> handler)
Description copied from interface:ArtifactsAsync
Lists repositories in the specified compartment.- Specified by:
listRepositories
in interfaceArtifactsAsync
- 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.
-
removeContainerVersion
public Future<RemoveContainerVersionResponse> removeContainerVersion(RemoveContainerVersionRequest request, AsyncHandler<RemoveContainerVersionRequest,RemoveContainerVersionResponse> handler)
Description copied from interface:ArtifactsAsync
Remove version from container image.- Specified by:
removeContainerVersion
in interfaceArtifactsAsync
- 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.
-
restoreContainerImage
public Future<RestoreContainerImageResponse> restoreContainerImage(RestoreContainerImageRequest request, AsyncHandler<RestoreContainerImageRequest,RestoreContainerImageResponse> handler)
Description copied from interface:ArtifactsAsync
Restore a container image.- Specified by:
restoreContainerImage
in interfaceArtifactsAsync
- 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.
-
updateContainerConfiguration
public Future<UpdateContainerConfigurationResponse> updateContainerConfiguration(UpdateContainerConfigurationRequest request, AsyncHandler<UpdateContainerConfigurationRequest,UpdateContainerConfigurationResponse> handler)
Description copied from interface:ArtifactsAsync
Update container configuration.- Specified by:
updateContainerConfiguration
in interfaceArtifactsAsync
- 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.
-
updateContainerImage
public Future<UpdateContainerImageResponse> updateContainerImage(UpdateContainerImageRequest request, AsyncHandler<UpdateContainerImageRequest,UpdateContainerImageResponse> handler)
Description copied from interface:ArtifactsAsync
Modify the properties of a container image.Avoid entering confidential information.
- Specified by:
updateContainerImage
in interfaceArtifactsAsync
- 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.
-
updateContainerImageSignature
public Future<UpdateContainerImageSignatureResponse> updateContainerImageSignature(UpdateContainerImageSignatureRequest request, AsyncHandler<UpdateContainerImageSignatureRequest,UpdateContainerImageSignatureResponse> handler)
Description copied from interface:ArtifactsAsync
Modify the properties of a container image signature.Avoid entering confidential information.
- Specified by:
updateContainerImageSignature
in interfaceArtifactsAsync
- 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.
-
updateContainerRepository
public Future<UpdateContainerRepositoryResponse> updateContainerRepository(UpdateContainerRepositoryRequest request, AsyncHandler<UpdateContainerRepositoryRequest,UpdateContainerRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Modify the properties of a container repository.Avoid entering confidential information.
- Specified by:
updateContainerRepository
in interfaceArtifactsAsync
- 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.
-
updateGenericArtifact
public Future<UpdateGenericArtifactResponse> updateGenericArtifact(UpdateGenericArtifactRequest request, AsyncHandler<UpdateGenericArtifactRequest,UpdateGenericArtifactResponse> handler)
Description copied from interface:ArtifactsAsync
Updates the artifact with the specified OCID.You can only update the tags of an artifact.
- Specified by:
updateGenericArtifact
in interfaceArtifactsAsync
- 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.
-
updateGenericArtifactByPath
public Future<UpdateGenericArtifactByPathResponse> updateGenericArtifactByPath(UpdateGenericArtifactByPathRequest request, AsyncHandler<UpdateGenericArtifactByPathRequest,UpdateGenericArtifactByPathResponse> handler)
Description copied from interface:ArtifactsAsync
Updates an artifact with a specifiedartifactPath
andversion
.You can only update the tags of an artifact.
- Specified by:
updateGenericArtifactByPath
in interfaceArtifactsAsync
- 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.
-
updateRepository
public Future<UpdateRepositoryResponse> updateRepository(UpdateRepositoryRequest request, AsyncHandler<UpdateRepositoryRequest,UpdateRepositoryResponse> handler)
Description copied from interface:ArtifactsAsync
Updates the properties of a repository.You can update the
displayName
anddescription
properties.- Specified by:
updateRepository
in interfaceArtifactsAsync
- 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)
-
-