@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 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 |
ArtifactsAsyncClient.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 Artifacts.
|
Constructor and Description |
---|
ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
ArtifactsAsyncClient(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 Artifacts.
public final String clientCommonLibraryVersion
@Deprecated public ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public ArtifactsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ArtifactsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public ArtifactsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ArtifactsAsyncClient.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 ArtifactsAsyncClient(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 ArtifactsAsyncClient.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 ArtifactsAsyncClient(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 ArtifactsAsyncClient.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 ArtifactsAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
setRegion
in interface ArtifactsAsync
region
- The region of the service.public void setRegion(String regionId)
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 call setEndpoint
.
setRegion
in interface ArtifactsAsync
regionId
- The public region ID.public Future<ChangeContainerRepositoryCompartmentResponse> changeContainerRepositoryCompartment(ChangeContainerRepositoryCompartmentRequest request, AsyncHandler<ChangeContainerRepositoryCompartmentRequest,ChangeContainerRepositoryCompartmentResponse> handler)
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.
changeContainerRepositoryCompartment
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeRepositoryCompartmentResponse> changeRepositoryCompartment(ChangeRepositoryCompartmentRequest request, AsyncHandler<ChangeRepositoryCompartmentRequest,ChangeRepositoryCompartmentResponse> handler)
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.
changeRepositoryCompartment
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateContainerImageSignatureResponse> createContainerImageSignature(CreateContainerImageSignatureRequest request, AsyncHandler<CreateContainerImageSignatureRequest,CreateContainerImageSignatureResponse> handler)
ArtifactsAsync
Upload a signature to an image.
createContainerImageSignature
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateContainerRepositoryResponse> createContainerRepository(CreateContainerRepositoryRequest request, AsyncHandler<CreateContainerRepositoryRequest,CreateContainerRepositoryResponse> handler)
ArtifactsAsync
Create a new empty container repository. Avoid entering confidential information.
createContainerRepository
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateRepositoryResponse> createRepository(CreateRepositoryRequest request, AsyncHandler<CreateRepositoryRequest,CreateRepositoryResponse> handler)
ArtifactsAsync
Creates a new repository for storing artifacts.
createRepository
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteContainerImageResponse> deleteContainerImage(DeleteContainerImageRequest request, AsyncHandler<DeleteContainerImageRequest,DeleteContainerImageResponse> handler)
ArtifactsAsync
Delete a container image.
deleteContainerImage
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteContainerImageSignatureResponse> deleteContainerImageSignature(DeleteContainerImageSignatureRequest request, AsyncHandler<DeleteContainerImageSignatureRequest,DeleteContainerImageSignatureResponse> handler)
ArtifactsAsync
Delete a container image signature.
deleteContainerImageSignature
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteContainerRepositoryResponse> deleteContainerRepository(DeleteContainerRepositoryRequest request, AsyncHandler<DeleteContainerRepositoryRequest,DeleteContainerRepositoryResponse> handler)
ArtifactsAsync
Delete container repository.
deleteContainerRepository
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteGenericArtifactResponse> deleteGenericArtifact(DeleteGenericArtifactRequest request, AsyncHandler<DeleteGenericArtifactRequest,DeleteGenericArtifactResponse> handler)
ArtifactsAsync
Deletes an artifact with a specified OCID.
deleteGenericArtifact
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteGenericArtifactByPathResponse> deleteGenericArtifactByPath(DeleteGenericArtifactByPathRequest request, AsyncHandler<DeleteGenericArtifactByPathRequest,DeleteGenericArtifactByPathResponse> handler)
ArtifactsAsync
Deletes an artifact with a specified artifactPath
and version
.
deleteGenericArtifactByPath
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest request, AsyncHandler<DeleteRepositoryRequest,DeleteRepositoryResponse> handler)
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.
deleteRepository
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetContainerConfigurationResponse> getContainerConfiguration(GetContainerConfigurationRequest request, AsyncHandler<GetContainerConfigurationRequest,GetContainerConfigurationResponse> handler)
ArtifactsAsync
Get container configuration.
getContainerConfiguration
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetContainerImageResponse> getContainerImage(GetContainerImageRequest request, AsyncHandler<GetContainerImageRequest,GetContainerImageResponse> handler)
ArtifactsAsync
Get container image metadata.
getContainerImage
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetContainerImageSignatureResponse> getContainerImageSignature(GetContainerImageSignatureRequest request, AsyncHandler<GetContainerImageSignatureRequest,GetContainerImageSignatureResponse> handler)
ArtifactsAsync
Get container image signature metadata.
getContainerImageSignature
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetContainerRepositoryResponse> getContainerRepository(GetContainerRepositoryRequest request, AsyncHandler<GetContainerRepositoryRequest,GetContainerRepositoryResponse> handler)
ArtifactsAsync
Get container repository.
getContainerRepository
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetGenericArtifactResponse> getGenericArtifact(GetGenericArtifactRequest request, AsyncHandler<GetGenericArtifactRequest,GetGenericArtifactResponse> handler)
ArtifactsAsync
Gets information about an artifact with a specified OCID.
getGenericArtifact
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetGenericArtifactByPathResponse> getGenericArtifactByPath(GetGenericArtifactByPathRequest request, AsyncHandler<GetGenericArtifactByPathRequest,GetGenericArtifactByPathResponse> handler)
ArtifactsAsync
Gets information about an artifact with a specified artifactPath
and version
.
getGenericArtifactByPath
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetRepositoryResponse> getRepository(GetRepositoryRequest request, AsyncHandler<GetRepositoryRequest,GetRepositoryResponse> handler)
ArtifactsAsync
Gets the specified repository’s information.
getRepository
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListContainerImageSignaturesResponse> listContainerImageSignatures(ListContainerImageSignaturesRequest request, AsyncHandler<ListContainerImageSignaturesRequest,ListContainerImageSignaturesResponse> handler)
ArtifactsAsync
List container image signatures in an image.
listContainerImageSignatures
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListContainerImagesResponse> listContainerImages(ListContainerImagesRequest request, AsyncHandler<ListContainerImagesRequest,ListContainerImagesResponse> handler)
ArtifactsAsync
List container images in a compartment.
listContainerImages
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListContainerRepositoriesResponse> listContainerRepositories(ListContainerRepositoriesRequest request, AsyncHandler<ListContainerRepositoriesRequest,ListContainerRepositoriesResponse> handler)
ArtifactsAsync
List container repositories in a compartment.
listContainerRepositories
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListGenericArtifactsResponse> listGenericArtifacts(ListGenericArtifactsRequest request, AsyncHandler<ListGenericArtifactsRequest,ListGenericArtifactsResponse> handler)
ArtifactsAsync
Lists artifacts in the specified repository.
listGenericArtifacts
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListRepositoriesResponse> listRepositories(ListRepositoriesRequest request, AsyncHandler<ListRepositoriesRequest,ListRepositoriesResponse> handler)
ArtifactsAsync
Lists repositories in the specified compartment.
listRepositories
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveContainerVersionResponse> removeContainerVersion(RemoveContainerVersionRequest request, AsyncHandler<RemoveContainerVersionRequest,RemoveContainerVersionResponse> handler)
ArtifactsAsync
Remove version from container image.
removeContainerVersion
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RestoreContainerImageResponse> restoreContainerImage(RestoreContainerImageRequest request, AsyncHandler<RestoreContainerImageRequest,RestoreContainerImageResponse> handler)
ArtifactsAsync
Restore a container image.
restoreContainerImage
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateContainerConfigurationResponse> updateContainerConfiguration(UpdateContainerConfigurationRequest request, AsyncHandler<UpdateContainerConfigurationRequest,UpdateContainerConfigurationResponse> handler)
ArtifactsAsync
Update container configuration.
updateContainerConfiguration
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateContainerImageResponse> updateContainerImage(UpdateContainerImageRequest request, AsyncHandler<UpdateContainerImageRequest,UpdateContainerImageResponse> handler)
ArtifactsAsync
Modify the properties of a container image. Avoid entering confidential information.
updateContainerImage
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateContainerImageSignatureResponse> updateContainerImageSignature(UpdateContainerImageSignatureRequest request, AsyncHandler<UpdateContainerImageSignatureRequest,UpdateContainerImageSignatureResponse> handler)
ArtifactsAsync
Modify the properties of a container image signature. Avoid entering confidential information.
updateContainerImageSignature
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateContainerRepositoryResponse> updateContainerRepository(UpdateContainerRepositoryRequest request, AsyncHandler<UpdateContainerRepositoryRequest,UpdateContainerRepositoryResponse> handler)
ArtifactsAsync
Modify the properties of a container repository. Avoid entering confidential information.
updateContainerRepository
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateGenericArtifactResponse> updateGenericArtifact(UpdateGenericArtifactRequest request, AsyncHandler<UpdateGenericArtifactRequest,UpdateGenericArtifactResponse> handler)
ArtifactsAsync
Updates the artifact with the specified OCID. You can only update the tags of an artifact.
updateGenericArtifact
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateGenericArtifactByPathResponse> updateGenericArtifactByPath(UpdateGenericArtifactByPathRequest request, AsyncHandler<UpdateGenericArtifactByPathRequest,UpdateGenericArtifactByPathResponse> handler)
ArtifactsAsync
Updates an artifact with a specified artifactPath
and version
. You can only update the
tags of an artifact.
updateGenericArtifactByPath
in interface ArtifactsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateRepositoryResponse> updateRepository(UpdateRepositoryRequest request, AsyncHandler<UpdateRepositoryRequest,UpdateRepositoryResponse> handler)
ArtifactsAsync
Updates the properties of a repository. You can update the displayName
and description
properties.
updateRepository
in interface ArtifactsAsync
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.