Package com.oracle.bmc.artifacts

Interface ArtifactsAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ArtifactsAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public interface ArtifactsAsync
extends AutoCloseable
    API covering the Artifacts and Registry services.

    Use this API to manage resources such as generic artifacts and container images.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        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.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        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.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • createContainerRepository

        Future<CreateContainerRepositoryResponse> createContainerRepository​(CreateContainerRepositoryRequest request,
                                                                    AsyncHandler<CreateContainerRepositoryRequest,​CreateContainerRepositoryResponse> handler)
        Create a new empty container repository.

        Avoid entering confidential information.

        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<CreateRepositoryResponse> createRepository​(CreateRepositoryRequest request,
                                                  AsyncHandler<CreateRepositoryRequest,​CreateRepositoryResponse> handler)
        Creates a new repository for storing artifacts.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<DeleteContainerImageResponse> deleteContainerImage​(DeleteContainerImageRequest request,
                                                          AsyncHandler<DeleteContainerImageRequest,​DeleteContainerImageResponse> handler)
        Delete a container image.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<DeleteGenericArtifactResponse> deleteGenericArtifact​(DeleteGenericArtifactRequest request,
                                                            AsyncHandler<DeleteGenericArtifactRequest,​DeleteGenericArtifactResponse> handler)
        Deletes an artifact with a specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<DeleteRepositoryResponse> deleteRepository​(DeleteRepositoryRequest request,
                                                  AsyncHandler<DeleteRepositoryRequest,​DeleteRepositoryResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<GetContainerImageResponse> getContainerImage​(GetContainerImageRequest request,
                                                    AsyncHandler<GetContainerImageRequest,​GetContainerImageResponse> handler)
        Get container image metadata.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<GetGenericArtifactResponse> getGenericArtifact​(GetGenericArtifactRequest request,
                                                      AsyncHandler<GetGenericArtifactRequest,​GetGenericArtifactResponse> handler)
        Gets information about an artifact with a specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<GetGenericArtifactByPathResponse> getGenericArtifactByPath​(GetGenericArtifactByPathRequest request,
                                                                  AsyncHandler<GetGenericArtifactByPathRequest,​GetGenericArtifactByPathResponse> handler)
        Gets information about an artifact with a specified artifactPath and version.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<GetRepositoryResponse> getRepository​(GetRepositoryRequest request,
                                            AsyncHandler<GetRepositoryRequest,​GetRepositoryResponse> handler)
        Gets the specified repository’s information.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<ListContainerImagesResponse> listContainerImages​(ListContainerImagesRequest request,
                                                        AsyncHandler<ListContainerImagesRequest,​ListContainerImagesResponse> handler)
        List container images in a compartment.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<ListGenericArtifactsResponse> listGenericArtifacts​(ListGenericArtifactsRequest request,
                                                          AsyncHandler<ListGenericArtifactsRequest,​ListGenericArtifactsResponse> handler)
        Lists artifacts in the specified repository.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<ListRepositoriesResponse> listRepositories​(ListRepositoriesRequest request,
                                                  AsyncHandler<ListRepositoriesRequest,​ListRepositoriesResponse> handler)
        Lists repositories in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<RemoveContainerVersionResponse> removeContainerVersion​(RemoveContainerVersionRequest request,
                                                              AsyncHandler<RemoveContainerVersionRequest,​RemoveContainerVersionResponse> handler)
        Remove version from container image.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<RestoreContainerImageResponse> restoreContainerImage​(RestoreContainerImageRequest request,
                                                            AsyncHandler<RestoreContainerImageRequest,​RestoreContainerImageResponse> handler)
        Restore a container image.
        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<UpdateContainerImageResponse> updateContainerImage​(UpdateContainerImageRequest request,
                                                          AsyncHandler<UpdateContainerImageRequest,​UpdateContainerImageResponse> handler)
        Modify the properties of a container image.

        Avoid entering confidential information.

        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<UpdateContainerRepositoryResponse> updateContainerRepository​(UpdateContainerRepositoryRequest request,
                                                                    AsyncHandler<UpdateContainerRepositoryRequest,​UpdateContainerRepositoryResponse> handler)
        Modify the properties of a container repository.

        Avoid entering confidential information.

        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<UpdateGenericArtifactResponse> updateGenericArtifact​(UpdateGenericArtifactRequest request,
                                                            AsyncHandler<UpdateGenericArtifactRequest,​UpdateGenericArtifactResponse> handler)
        Updates the artifact with the specified OCID.

        You can only update the tags of an artifact.

        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<UpdateGenericArtifactByPathResponse> updateGenericArtifactByPath​(UpdateGenericArtifactByPathRequest request,
                                                                        AsyncHandler<UpdateGenericArtifactByPathRequest,​UpdateGenericArtifactByPathResponse> handler)
        Updates an artifact with a specified artifactPath and version.

        You can only update the tags of an artifact.

        Parameters:
        request - The request object containing the details to send
        handler - 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

        Future<UpdateRepositoryResponse> updateRepository​(UpdateRepositoryRequest request,
                                                  AsyncHandler<UpdateRepositoryRequest,​UpdateRepositoryResponse> handler)
        Updates the properties of a repository.

        You can update the displayName and description properties.

        Parameters:
        request - The request object containing the details to send
        handler - 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.