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 ArtifactsAsyncAsync 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 classArtifactsAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Artifacts.
-
Constructor Summary
Constructors Constructor Description ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
ArtifactsAsyncClient
@Deprecated public ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
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:ArtifactsAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceArtifactsAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ArtifactsAsyncSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
setRegionin interfaceArtifactsAsync- Parameters:
regionId- The public region ID.
-
changeContainerRepositoryCompartment
public Future<ChangeContainerRepositoryCompartmentResponse> changeContainerRepositoryCompartment(ChangeContainerRepositoryCompartmentRequest request, AsyncHandler<ChangeContainerRepositoryCompartmentRequest,ChangeContainerRepositoryCompartmentResponse> handler)
Description copied from interface:ArtifactsAsyncMoves 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:
changeContainerRepositoryCompartmentin 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:ArtifactsAsyncMoves 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:
changeRepositoryCompartmentin 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:ArtifactsAsyncUpload a signature to an image.- Specified by:
createContainerImageSignaturein 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:ArtifactsAsyncCreate a new empty container repository.Avoid entering confidential information.
- Specified by:
createContainerRepositoryin 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:ArtifactsAsyncCreates a new repository for storing artifacts.- Specified by:
createRepositoryin 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:ArtifactsAsyncDelete a container image.- Specified by:
deleteContainerImagein 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:ArtifactsAsyncDelete a container image signature.- Specified by:
deleteContainerImageSignaturein 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:ArtifactsAsyncDelete container repository.- Specified by:
deleteContainerRepositoryin 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:ArtifactsAsyncDeletes an artifact with a specified OCID.- Specified by:
deleteGenericArtifactin 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:ArtifactsAsyncDeletes an artifact with a specifiedartifactPathandversion.- Specified by:
deleteGenericArtifactByPathin 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:ArtifactsAsyncDeletes 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:
deleteRepositoryin 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:ArtifactsAsyncGet container configuration.- Specified by:
getContainerConfigurationin 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:ArtifactsAsyncGet container image metadata.- Specified by:
getContainerImagein 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:ArtifactsAsyncGet container image signature metadata.- Specified by:
getContainerImageSignaturein 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:ArtifactsAsyncGet container repository.- Specified by:
getContainerRepositoryin 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:ArtifactsAsyncGets information about an artifact with a specified OCID.- Specified by:
getGenericArtifactin 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:ArtifactsAsyncGets information about an artifact with a specifiedartifactPathandversion.- Specified by:
getGenericArtifactByPathin 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:ArtifactsAsyncGets the specified repository’s information.- Specified by:
getRepositoryin 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:ArtifactsAsyncList container image signatures in an image.- Specified by:
listContainerImageSignaturesin 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:ArtifactsAsyncList container images in a compartment.- Specified by:
listContainerImagesin 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:ArtifactsAsyncList container repositories in a compartment.- Specified by:
listContainerRepositoriesin 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:ArtifactsAsyncLists artifacts in the specified repository.- Specified by:
listGenericArtifactsin 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:ArtifactsAsyncLists repositories in the specified compartment.- Specified by:
listRepositoriesin 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:ArtifactsAsyncRemove version from container image.- Specified by:
removeContainerVersionin 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:ArtifactsAsyncRestore a container image.- Specified by:
restoreContainerImagein 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:ArtifactsAsyncUpdate container configuration.- Specified by:
updateContainerConfigurationin 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:ArtifactsAsyncModify the properties of a container image.Avoid entering confidential information.
- Specified by:
updateContainerImagein 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:ArtifactsAsyncModify the properties of a container image signature.Avoid entering confidential information.
- Specified by:
updateContainerImageSignaturein 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:ArtifactsAsyncModify the properties of a container repository.Avoid entering confidential information.
- Specified by:
updateContainerRepositoryin 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:ArtifactsAsyncUpdates the artifact with the specified OCID.You can only update the tags of an artifact.
- Specified by:
updateGenericArtifactin 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:ArtifactsAsyncUpdates an artifact with a specifiedartifactPathandversion.You can only update the tags of an artifact.
- Specified by:
updateGenericArtifactByPathin 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:ArtifactsAsyncUpdates the properties of a repository.You can update the
displayNameanddescriptionproperties.- Specified by:
updateRepositoryin 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
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
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)
-
-