com.oracle.bmc.artifacts

Interface Artifacts

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ArtifactsClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public interface Artifacts
extends AutoCloseable

API covering the Registry services. Use this API to manage resources such as container images and repositories.

Method Summary

Modifier and Type	Method and Description
ChangeContainerRepositoryCompartmentResponse	changeContainerRepositoryCompartment(ChangeContainerRepositoryCompartmentRequest request) Moves a container repository into a different compartment within the same tenancy.
CreateContainerRepositoryResponse	createContainerRepository(CreateContainerRepositoryRequest request) Create a new empty container repository.
DeleteContainerImageResponse	deleteContainerImage(DeleteContainerImageRequest request) Delete a container image.
DeleteContainerRepositoryResponse	deleteContainerRepository(DeleteContainerRepositoryRequest request) Delete container repository.
GetContainerConfigurationResponse	getContainerConfiguration(GetContainerConfigurationRequest request) Get container configuration.
GetContainerImageResponse	getContainerImage(GetContainerImageRequest request) Get container image metadata.
GetContainerRepositoryResponse	getContainerRepository(GetContainerRepositoryRequest request) Get container repository.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
ArtifactsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ArtifactsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListContainerImagesResponse	listContainerImages(ListContainerImagesRequest request) List container images in a compartment.
ListContainerRepositoriesResponse	listContainerRepositories(ListContainerRepositoriesRequest request) List container repositories in a compartment.
RemoveContainerVersionResponse	removeContainerVersion(RemoveContainerVersionRequest request) Remove version from container image.
RestoreContainerImageResponse	restoreContainerImage(RestoreContainerImageRequest request) Restore a container image.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
UpdateContainerConfigurationResponse	updateContainerConfiguration(UpdateContainerConfigurationRequest request) Update container configuration.
UpdateContainerRepositoryResponse	updateContainerRepository(UpdateContainerRepositoryRequest request) Modify the properties of a container repository.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

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.

changeContainerRepositoryCompartment

ChangeContainerRepositoryCompartmentResponse 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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeContainerRepositoryCompartment API.

createContainerRepository

CreateContainerRepositoryResponse createContainerRepository(CreateContainerRepositoryRequest request)

Create a new empty container repository. Avoid entering confidential information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateContainerRepository API.

deleteContainerImage

DeleteContainerImageResponse deleteContainerImage(DeleteContainerImageRequest request)

Delete a container image.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteContainerImage API.

deleteContainerRepository

DeleteContainerRepositoryResponse deleteContainerRepository(DeleteContainerRepositoryRequest request)

Delete container repository.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteContainerRepository API.

getContainerConfiguration

GetContainerConfigurationResponse getContainerConfiguration(GetContainerConfigurationRequest request)

Get container configuration.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetContainerConfiguration API.

getContainerImage

GetContainerImageResponse getContainerImage(GetContainerImageRequest request)

Get container image metadata.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetContainerImage API.

getContainerRepository

GetContainerRepositoryResponse getContainerRepository(GetContainerRepositoryRequest request)

Get container repository.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetContainerRepository API.

listContainerImages

ListContainerImagesResponse listContainerImages(ListContainerImagesRequest request)

List container images in a compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListContainerImages API.

listContainerRepositories

ListContainerRepositoriesResponse listContainerRepositories(ListContainerRepositoriesRequest request)

List container repositories in a compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListContainerRepositories API.

removeContainerVersion

RemoveContainerVersionResponse removeContainerVersion(RemoveContainerVersionRequest request)

Remove version from container image.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use RemoveContainerVersion API.

restoreContainerImage

RestoreContainerImageResponse restoreContainerImage(RestoreContainerImageRequest request)

Restore a container image.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use RestoreContainerImage API.

updateContainerConfiguration

UpdateContainerConfigurationResponse updateContainerConfiguration(UpdateContainerConfigurationRequest request)

Update container configuration.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateContainerConfiguration API.

updateContainerRepository

UpdateContainerRepositoryResponse updateContainerRepository(UpdateContainerRepositoryRequest request)

Modify the properties of a container repository. Avoid entering confidential information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateContainerRepository API.

getWaiters

ArtifactsWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

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.

Returns:

The service paginators.