@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface Artifacts extends AutoCloseable
API covering the Artifacts and Registry services. Use this API to manage resources such as generic artifacts and container images.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateChangeContainerRepositoryCompartmentResponse changeContainerRepositoryCompartment(ChangeContainerRepositoryCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeContainerRepositoryCompartment API.
ChangeRepositoryCompartmentResponse changeRepositoryCompartment(ChangeRepositoryCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeRepositoryCompartment API.
CreateContainerImageSignatureResponse createContainerImageSignature(CreateContainerImageSignatureRequest request)
Upload a signature to an image.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateContainerImageSignature API.
CreateContainerRepositoryResponse createContainerRepository(CreateContainerRepositoryRequest request)
Create a new empty container repository. Avoid entering confidential information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateContainerRepository API.
CreateRepositoryResponse createRepository(CreateRepositoryRequest request)
Creates a new repository for storing artifacts.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateRepository API.
DeleteContainerImageResponse deleteContainerImage(DeleteContainerImageRequest request)
Delete a container image.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteContainerImage API.
DeleteContainerImageSignatureResponse deleteContainerImageSignature(DeleteContainerImageSignatureRequest request)
Delete a container image signature.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteContainerImageSignature API.
DeleteContainerRepositoryResponse deleteContainerRepository(DeleteContainerRepositoryRequest request)
Delete container repository.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteContainerRepository API.
DeleteGenericArtifactResponse deleteGenericArtifact(DeleteGenericArtifactRequest request)
Deletes an artifact with a specified OCID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteGenericArtifact API.
DeleteGenericArtifactByPathResponse deleteGenericArtifactByPath(DeleteGenericArtifactByPathRequest request)
Deletes an artifact with a specified artifactPath
and version
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteGenericArtifactByPath API.
DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteRepository API.
GetContainerConfigurationResponse getContainerConfiguration(GetContainerConfigurationRequest request)
Get container configuration.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetContainerConfiguration API.
GetContainerImageResponse getContainerImage(GetContainerImageRequest request)
Get container image metadata.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetContainerImage API.
GetContainerImageSignatureResponse getContainerImageSignature(GetContainerImageSignatureRequest request)
Get container image signature metadata.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetContainerImageSignature API.
GetContainerRepositoryResponse getContainerRepository(GetContainerRepositoryRequest request)
Get container repository.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetContainerRepository API.
GetGenericArtifactResponse getGenericArtifact(GetGenericArtifactRequest request)
Gets information about an artifact with a specified OCID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetGenericArtifact API.
GetGenericArtifactByPathResponse getGenericArtifactByPath(GetGenericArtifactByPathRequest request)
Gets information about an artifact with a specified artifactPath
and version
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetGenericArtifactByPath API.
GetRepositoryResponse getRepository(GetRepositoryRequest request)
Gets the specified repository’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetRepository API.
ListContainerImageSignaturesResponse listContainerImageSignatures(ListContainerImageSignaturesRequest request)
List container image signatures in an image.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListContainerImageSignatures API.
ListContainerImagesResponse listContainerImages(ListContainerImagesRequest request)
List container images in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListContainerImages API.
ListContainerRepositoriesResponse listContainerRepositories(ListContainerRepositoriesRequest request)
List container repositories in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListContainerRepositories API.
ListGenericArtifactsResponse listGenericArtifacts(ListGenericArtifactsRequest request)
Lists artifacts in the specified repository.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListGenericArtifacts API.
ListRepositoriesResponse listRepositories(ListRepositoriesRequest request)
Lists repositories in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListRepositories API.
RemoveContainerVersionResponse removeContainerVersion(RemoveContainerVersionRequest request)
Remove version from container image.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveContainerVersion API.
RestoreContainerImageResponse restoreContainerImage(RestoreContainerImageRequest request)
Restore a container image.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RestoreContainerImage API.
UpdateContainerConfigurationResponse updateContainerConfiguration(UpdateContainerConfigurationRequest request)
Update container configuration.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateContainerConfiguration API.
UpdateContainerImageResponse updateContainerImage(UpdateContainerImageRequest request)
Modify the properties of a container image. Avoid entering confidential information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateContainerImage API.
UpdateContainerImageSignatureResponse updateContainerImageSignature(UpdateContainerImageSignatureRequest request)
Modify the properties of a container image signature. Avoid entering confidential information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateContainerImageSignature API.
UpdateContainerRepositoryResponse updateContainerRepository(UpdateContainerRepositoryRequest request)
Modify the properties of a container repository. Avoid entering confidential information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateContainerRepository API.
UpdateGenericArtifactResponse updateGenericArtifact(UpdateGenericArtifactRequest request)
Updates the artifact with the specified OCID. You can only update the tags of an artifact.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateGenericArtifact API.
UpdateGenericArtifactByPathResponse updateGenericArtifactByPath(UpdateGenericArtifactByPathRequest request)
Updates an artifact with a specified artifactPath
and version
. You can only update the
tags of an artifact.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateGenericArtifactByPath API.
UpdateRepositoryResponse updateRepository(UpdateRepositoryRequest request)
Updates the properties of a repository. You can update the displayName
and description
properties.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateRepository API.
ArtifactsWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
ArtifactsPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
Copyright © 2016–2024. All rights reserved.