Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArtifactsClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • ArtifactsClient

Constructors

constructor

  • new ArtifactsClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): ArtifactsClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: ArtifactsWaiter

targetService

targetService: string = "Artifacts"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://artifacts.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeContainerRepositoryCompartment

changeRepositoryCompartment

close

  • close(): void

createContainerImageSignature

createContainerRepository

  • Create a new empty container repository. Avoid entering confidential information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateContainerRepository API.

    Parameters

    Returns Promise<CreateContainerRepositoryResponse>

    CreateContainerRepositoryResponse

createRepository

createWaiters

  • Creates a new ArtifactsWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns ArtifactsWaiter

    The service waiters.

deleteContainerImage

deleteContainerImageSignature

deleteContainerRepository

deleteGenericArtifact

deleteGenericArtifactByPath

deleteRepository

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRepository API.

    Parameters

    Returns Promise<DeleteRepositoryResponse>

    DeleteRepositoryResponse

getContainerConfiguration

getContainerImage

getContainerImageSignature

getContainerRepository

getGenericArtifact

getGenericArtifactByPath

  • Gets information about an artifact with a specified artifactPath and version. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetGenericArtifactByPath API.

    Parameters

    Returns Promise<GetGenericArtifactByPathResponse>

    GetGenericArtifactByPathResponse

getRepository

  • Gets the specified repository's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRepository API.

    Parameters

    Returns Promise<GetRepositoryResponse>

    GetRepositoryResponse

getWaiters

listContainerImageSignatures

listContainerImages

listContainerRepositories

listGenericArtifacts

listRepositories

  • Lists repositories in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRepositories API.

    Parameters

    Returns Promise<ListRepositoriesResponse>

    ListRepositoriesResponse

removeContainerVersion

restoreContainerImage

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateContainerConfiguration

updateContainerImage

  • Modify the properties of a container image. Avoid entering confidential information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateContainerImage API.

    Parameters

    Returns Promise<UpdateContainerImageResponse>

    UpdateContainerImageResponse

updateContainerImageSignature

  • Modify the properties of a container image signature. Avoid entering confidential information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateContainerImageSignature API.

    Parameters

    Returns Promise<UpdateContainerImageSignatureResponse>

    UpdateContainerImageSignatureResponse

updateContainerRepository

  • Modify the properties of a container repository. Avoid entering confidential information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateContainerRepository API.

    Parameters

    Returns Promise<UpdateContainerRepositoryResponse>

    UpdateContainerRepositoryResponse

updateGenericArtifact

  • Updates the artifact with the specified OCID. You can only update the tags of an artifact. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateGenericArtifact API.

    Parameters

    Returns Promise<UpdateGenericArtifactResponse>

    UpdateGenericArtifactResponse

updateGenericArtifactByPath

  • Updates an artifact with a specified artifactPath and version. You can only update the tags of an artifact. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateGenericArtifactByPath API.

    Parameters

    Returns Promise<UpdateGenericArtifactByPathResponse>

    UpdateGenericArtifactByPathResponse

updateRepository

  • Updates the properties of a repository. You can update the displayName and description properties. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateRepository API.

    Parameters

    Returns Promise<UpdateRepositoryResponse>

    UpdateRepositoryResponse