Class: OCI::Artifacts::ArtifactsClient

Inherits:

Object

Object
OCI::Artifacts::ArtifactsClient

show all

Defined in:: lib/oci/artifacts/artifacts_client.rb

Overview

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

Instance Attribute Summary collapse

#api_client ⇒ OCI::ApiClient readonly

Client used to make HTTP requests.
#endpoint ⇒ String readonly

Fully qualified endpoint URL.
#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.
#retry_config ⇒ OCI::Retry::RetryConfig readonly

The default retry configuration to apply to all operations in this service client.

Instance Method Summary collapse

#change_container_repository_compartment(repository_id, change_container_repository_compartment_details, opts = {}) ⇒ Response

Moves a container repository into a different compartment within the same tenancy.
#change_repository_compartment(repository_id, change_repository_compartment_details, opts = {}) ⇒ Response

Moves a repository into a different compartment within the same tenancy.
#create_container_image_signature(create_container_image_signature_details, opts = {}) ⇒ Response

Upload a signature to an image.
#create_container_repository(create_container_repository_details, opts = {}) ⇒ Response

Create a new empty container repository.
#create_repository(create_repository_details, opts = {}) ⇒ Response

Creates a new repository for storing artifacts.
#delete_container_image(image_id, opts = {}) ⇒ Response

Delete a container image.
#delete_container_image_signature(image_signature_id, opts = {}) ⇒ Response

Delete a container image signature.
#delete_container_repository(repository_id, opts = {}) ⇒ Response

Delete container repository.
#delete_generic_artifact(artifact_id, opts = {}) ⇒ Response

Deletes an artifact with a specified OCID.
#delete_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ Response

Deletes an artifact with a specified artifactPath and version.
#delete_repository(repository_id, opts = {}) ⇒ Response

Deletes the specified repository.
#get_container_configuration(compartment_id, opts = {}) ⇒ Response

Get container configuration.
#get_container_image(image_id, opts = {}) ⇒ Response

Get container image metadata.
#get_container_image_signature(image_signature_id, opts = {}) ⇒ Response

Get container image signature metadata.
#get_container_repository(repository_id, opts = {}) ⇒ Response

Get container repository.
#get_generic_artifact(artifact_id, opts = {}) ⇒ Response

Gets information about an artifact with a specified OCID.
#get_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ Response

Gets information about an artifact with a specified artifactPath and version.
#get_repository(repository_id, opts = {}) ⇒ Response

Gets the specified repository's information.
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ArtifactsClient constructor

Creates a new ArtifactsClient.
#list_container_image_signatures(compartment_id, opts = {}) ⇒ Response

List container image signatures in an image.
#list_container_images(compartment_id, opts = {}) ⇒ Response

List container images in a compartment.
#list_container_repositories(compartment_id, opts = {}) ⇒ Response

List container repositories in a compartment.
#list_generic_artifacts(compartment_id, repository_id, opts = {}) ⇒ Response

Lists artifacts in the specified repository.
#list_repositories(compartment_id, opts = {}) ⇒ Response

Lists repositories in the specified compartment.
#logger ⇒ Logger

The logger for this client.
#remove_container_version(image_id, remove_container_version_details, opts = {}) ⇒ Response

Remove version from container image.
#restore_container_image(image_id, restore_container_image_details, opts = {}) ⇒ Response

Restore a container image.
#update_container_configuration(compartment_id, update_container_configuration_details, opts = {}) ⇒ Response

Update container configuration.
#update_container_image(image_id, update_container_image_details, opts = {}) ⇒ Response

Modify the properties of a container image.
#update_container_image_signature(image_signature_id, update_container_image_signature_details, opts = {}) ⇒ Response

Modify the properties of a container image signature.
#update_container_repository(repository_id, update_container_repository_details, opts = {}) ⇒ Response

Modify the properties of a container repository.
#update_generic_artifact(artifact_id, update_generic_artifact_details, opts = {}) ⇒ Response

Updates the artifact with the specified OCID.
#update_generic_artifact_by_path(repository_id, artifact_path, version, update_generic_artifact_by_path_details, opts = {}) ⇒ Response

Updates an artifact with a specified artifactPath and version.
#update_repository(repository_id, update_repository_details, opts = {}) ⇒ Response

Updates the properties of a repository.

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ `ArtifactsClient`

Creates a new ArtifactsClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

config (Config) (defaults to: nil) —

A Config object.
region (String) (defaults to: nil) —

A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.
endpoint (String) (defaults to: nil) —

The fully qualified endpoint URL
signer (OCI::BaseSigner) (defaults to: nil) —

A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client
proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter
retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

# File 'lib/oci/artifacts/artifacts_client.rb', line 56

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20160918'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ArtifactsClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ `OCI::ApiClient` (readonly)

Client used to make HTTP requests.

Returns:

(OCI::ApiClient)



16
17
18

# File 'lib/oci/artifacts/artifacts_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ `String` (readonly)

Fully qualified endpoint URL

Returns:

(String)



20
21
22

# File 'lib/oci/artifacts/artifacts_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ `String`

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

(String)



30
31
32

# File 'lib/oci/artifacts/artifacts_client.rb', line 30

def region
  @region
end

#retry_config ⇒ `OCI::Retry::RetryConfig` (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:

(OCI::Retry::RetryConfig)



26
27
28

# File 'lib/oci/artifacts/artifacts_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#change_container_repository_compartment(repository_id, change_container_repository_compartment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use change_container_repository_compartment API.

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:

repository_id (String) —

The OCID of the container repository.

Example: ocid1.containerrepo.oc1..exampleuniqueID
change_container_repository_compartment_details (OCI::Artifacts::Models::ChangeContainerRepositoryCompartmentDetails) —

Change container repository compartment details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 131

def change_container_repository_compartment(repository_id, change_container_repository_compartment_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#change_container_repository_compartment.' if logger

  raise "Missing the required parameter 'repository_id' when calling change_container_repository_compartment." if repository_id.nil?
  raise "Missing the required parameter 'change_container_repository_compartment_details' when calling change_container_repository_compartment." if change_container_repository_compartment_details.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/container/repositories/{repositoryId}/actions/changeCompartment'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_container_repository_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#change_container_repository_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_repository_compartment(repository_id, change_repository_compartment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use change_repository_compartment API.

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.

Parameters:

repository_id (String) —

The OCID of the repository.

Example: ocid1.artifactrepository.oc1..exampleuniqueID
change_repository_compartment_details (OCI::Artifacts::Models::ChangeRepositoryCompartmentDetails) —

Moves a repository into a different compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 207

def change_repository_compartment(repository_id, change_repository_compartment_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#change_repository_compartment.' if logger

  raise "Missing the required parameter 'repository_id' when calling change_repository_compartment." if repository_id.nil?
  raise "Missing the required parameter 'change_repository_compartment_details' when calling change_repository_compartment." if change_repository_compartment_details.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/repositories/{repositoryId}/actions/changeCompartment'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_repository_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#change_repository_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_container_image_signature(create_container_image_signature_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_container_image_signature API.

Upload a signature to an image.

Parameters:

create_container_image_signature_details (OCI::Artifacts::Models::CreateContainerImageSignatureDetails) —

Upload container image signature details
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

(Response) —

A Response object with data of type ContainerImageSignature

# File 'lib/oci/artifacts/artifacts_client.rb', line 276

def create_container_image_signature(create_container_image_signature_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#create_container_image_signature.' if logger

  raise "Missing the required parameter 'create_container_image_signature_details' when calling create_container_image_signature." if create_container_image_signature_details.nil?

  path = '/container/imageSignatures'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_container_image_signature_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#create_container_image_signature') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImageSignature'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_container_repository(create_container_repository_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_container_repository API.

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

Parameters:

create_container_repository_details (OCI::Artifacts::Models::CreateContainerRepositoryDetails) —

Create container repository details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

(Response) —

A Response object with data of type ContainerRepository

# File 'lib/oci/artifacts/artifacts_client.rb', line 340

def create_container_repository(create_container_repository_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#create_container_repository.' if logger

  raise "Missing the required parameter 'create_container_repository_details' when calling create_container_repository." if create_container_repository_details.nil?

  path = '/container/repositories'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_container_repository_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#create_container_repository') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerRepository'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_repository(create_repository_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_repository API.

Creates a new repository for storing artifacts.

Parameters:

create_repository_details (OCI::Artifacts::Models::CreateRepositoryDetails) —

Creates a new repository for storing artifacts.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

(Response) —

A Response object with data of type Repository

# File 'lib/oci/artifacts/artifacts_client.rb', line 403

def create_repository(create_repository_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#create_repository.' if logger

  raise "Missing the required parameter 'create_repository_details' when calling create_repository." if create_repository_details.nil?

  path = '/repositories'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_repository_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#create_repository') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::Repository'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_container_image(image_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_container_image API.

Delete a container image.

Parameters:

image_id (String) —

The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 467

def delete_container_image(image_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#delete_container_image.' if logger

  raise "Missing the required parameter 'image_id' when calling delete_container_image." if image_id.nil?
  raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id)

  path = '/container/images/{imageId}'.sub('{imageId}', image_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#delete_container_image') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_container_image_signature(image_signature_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_container_image_signature API.

Delete a container image signature.

Parameters:

image_signature_id (String) —

The OCID of the container image signature.

Example: ocid1.containersignature.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 530

def delete_container_image_signature(image_signature_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#delete_container_image_signature.' if logger

  raise "Missing the required parameter 'image_signature_id' when calling delete_container_image_signature." if image_signature_id.nil?
  raise "Parameter value for 'image_signature_id' must not be blank" if OCI::Internal::Util.blank_string?(image_signature_id)

  path = '/container/imageSignatures/{imageSignatureId}'.sub('{imageSignatureId}', image_signature_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#delete_container_image_signature') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_container_repository(repository_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_container_repository API.

Delete container repository.

Parameters:

repository_id (String) —

The OCID of the container repository.

Example: ocid1.containerrepo.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 593

def delete_container_repository(repository_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#delete_container_repository.' if logger

  raise "Missing the required parameter 'repository_id' when calling delete_container_repository." if repository_id.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/container/repositories/{repositoryId}'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#delete_container_repository') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_generic_artifact(artifact_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_generic_artifact API.

Deletes an artifact with a specified OCID.

Parameters:

artifact_id (String) —

The OCID of the artifact.

Example: ocid1.genericartifact.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 656

def delete_generic_artifact(artifact_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#delete_generic_artifact.' if logger

  raise "Missing the required parameter 'artifact_id' when calling delete_generic_artifact." if artifact_id.nil?
  raise "Parameter value for 'artifact_id' must not be blank" if OCI::Internal::Util.blank_string?(artifact_id)

  path = '/generic/artifacts/{artifactId}'.sub('{artifactId}', artifact_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#delete_generic_artifact') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_generic_artifact_by_path API.

Deletes an artifact with a specified artifactPath and version.

Parameters:

repository_id (String) —

The OCID of the repository.

Example: ocid1.artifactrepository.oc1..exampleuniqueID
artifact_path (String) —

A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.

Example: project01/my-web-app/artifact-abc
version (String) —

A user-defined string to describe the artifact version.

Example: 1.1.2 or 1.2-beta-2
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 727

def delete_generic_artifact_by_path(repository_id, artifact_path, version, opts = {})
  logger.debug 'Calling operation ArtifactsClient#delete_generic_artifact_by_path.' if logger

  raise "Missing the required parameter 'repository_id' when calling delete_generic_artifact_by_path." if repository_id.nil?
  raise "Missing the required parameter 'artifact_path' when calling delete_generic_artifact_by_path." if artifact_path.nil?
  raise "Missing the required parameter 'version' when calling delete_generic_artifact_by_path." if version.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)
  raise "Parameter value for 'artifact_path' must not be blank" if OCI::Internal::Util.blank_string?(artifact_path)
  raise "Parameter value for 'version' must not be blank" if OCI::Internal::Util.blank_string?(version)

  path = '/generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}'.sub('{repositoryId}', repository_id.to_s).sub('{artifactPath}', artifact_path.to_s).sub('{version}', version.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#delete_generic_artifact_by_path') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_repository(repository_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_repository API.

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:

repository_id (String) —

The OCID of the repository.

Example: ocid1.artifactrepository.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/artifacts/artifacts_client.rb', line 794

def delete_repository(repository_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#delete_repository.' if logger

  raise "Missing the required parameter 'repository_id' when calling delete_repository." if repository_id.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/repositories/{repositoryId}'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#delete_repository') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_container_configuration(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_container_configuration API.

Get container configuration.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ContainerConfiguration

# File 'lib/oci/artifacts/artifacts_client.rb', line 850

def get_container_configuration(compartment_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#get_container_configuration.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_container_configuration." if compartment_id.nil?

  path = '/container/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#get_container_configuration') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_container_image(image_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_container_image API.

Get container image metadata.

Parameters:

image_id (String) —

The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ContainerImage

# File 'lib/oci/artifacts/artifacts_client.rb', line 909

def get_container_image(image_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#get_container_image.' if logger

  raise "Missing the required parameter 'image_id' when calling get_container_image." if image_id.nil?
  raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id)

  path = '/container/images/{imageId}'.sub('{imageId}', image_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#get_container_image') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_container_image_signature(image_signature_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_container_image_signature API.

Get container image signature metadata.

Parameters:

image_signature_id (String) —

The OCID of the container image signature.

Example: ocid1.containersignature.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ContainerImageSignature

# File 'lib/oci/artifacts/artifacts_client.rb', line 968

def get_container_image_signature(image_signature_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#get_container_image_signature.' if logger

  raise "Missing the required parameter 'image_signature_id' when calling get_container_image_signature." if image_signature_id.nil?
  raise "Parameter value for 'image_signature_id' must not be blank" if OCI::Internal::Util.blank_string?(image_signature_id)

  path = '/container/imageSignatures/{imageSignatureId}'.sub('{imageSignatureId}', image_signature_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#get_container_image_signature') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImageSignature'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_container_repository(repository_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_container_repository API.

Get container repository.

Parameters:

repository_id (String) —

The OCID of the container repository.

Example: ocid1.containerrepo.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ContainerRepository

# File 'lib/oci/artifacts/artifacts_client.rb', line 1027

def get_container_repository(repository_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#get_container_repository.' if logger

  raise "Missing the required parameter 'repository_id' when calling get_container_repository." if repository_id.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/container/repositories/{repositoryId}'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#get_container_repository') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerRepository'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_generic_artifact(artifact_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_generic_artifact API.

Gets information about an artifact with a specified OCID.

Parameters:

artifact_id (String) —

The OCID of the artifact.

Example: ocid1.genericartifact.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type GenericArtifact

# File 'lib/oci/artifacts/artifacts_client.rb', line 1086

def get_generic_artifact(artifact_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#get_generic_artifact.' if logger

  raise "Missing the required parameter 'artifact_id' when calling get_generic_artifact." if artifact_id.nil?
  raise "Parameter value for 'artifact_id' must not be blank" if OCI::Internal::Util.blank_string?(artifact_id)

  path = '/generic/artifacts/{artifactId}'.sub('{artifactId}', artifact_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#get_generic_artifact') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::GenericArtifact'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_generic_artifact_by_path API.

Gets information about an artifact with a specified artifactPath and version.

Parameters:

repository_id (String) —

The OCID of the repository.

Example: ocid1.artifactrepository.oc1..exampleuniqueID
artifact_path (String) —

A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.

Example: project01/my-web-app/artifact-abc
version (String) —

A user-defined string to describe the artifact version.

Example: 1.1.2 or 1.2-beta-2
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type GenericArtifact

# File 'lib/oci/artifacts/artifacts_client.rb', line 1153

def get_generic_artifact_by_path(repository_id, artifact_path, version, opts = {})
  logger.debug 'Calling operation ArtifactsClient#get_generic_artifact_by_path.' if logger

  raise "Missing the required parameter 'repository_id' when calling get_generic_artifact_by_path." if repository_id.nil?
  raise "Missing the required parameter 'artifact_path' when calling get_generic_artifact_by_path." if artifact_path.nil?
  raise "Missing the required parameter 'version' when calling get_generic_artifact_by_path." if version.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)
  raise "Parameter value for 'artifact_path' must not be blank" if OCI::Internal::Util.blank_string?(artifact_path)
  raise "Parameter value for 'version' must not be blank" if OCI::Internal::Util.blank_string?(version)

  path = '/generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}'.sub('{repositoryId}', repository_id.to_s).sub('{artifactPath}', artifact_path.to_s).sub('{version}', version.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#get_generic_artifact_by_path') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::GenericArtifact'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_repository(repository_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_repository API.

Gets the specified repository's information.

Parameters:

repository_id (String) —

The OCID of the repository.

Example: ocid1.artifactrepository.oc1..exampleuniqueID
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type Repository

# File 'lib/oci/artifacts/artifacts_client.rb', line 1216

def get_repository(repository_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#get_repository.' if logger

  raise "Missing the required parameter 'repository_id' when calling get_repository." if repository_id.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/repositories/{repositoryId}'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#get_repository') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::Repository'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_container_image_signatures(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_container_image_signatures API.

List container image signatures in an image.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:compartment_id_in_subtree (BOOLEAN) —

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).
:image_id (String) —

A filter to return a container image summary only for the specified container image OCID.
:repository_id (String) —

A filter to return container images only for the specified container repository OCID.
:repository_name (String) —

A filter to return container images or container image signatures that match the repository name.

Example: foo or foo*
:image_digest (String) —

The digest of the container image.

Example: sha256:e7d38b3517548a1c71e41bffe9c8ae6d6d29546ce46bf62159837aad072c90aa
:display_name (String) —

A filter to return only resources that match the given display name exactly.
:kms_key_id (String) —

The OCID of the kmsKeyVersionId used to sign the container image.

Example: ocid1.keyversion.oc1..exampleuniqueID
:kms_key_version_id (String) —

The OCID of the kmsKeyVersionId used to sign the container image.

Example: ocid1.keyversion.oc1..exampleuniqueID
:signing_algorithm (String) —

The algorithm to be used for signing. These are the only supported signing algorithms for container images. Allowed values are: SHA_224_RSA_PKCS_PSS, SHA_256_RSA_PKCS_PSS, SHA_384_RSA_PKCS_PSS, SHA_512_RSA_PKCS_PSS
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: 50
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:sort_by (String) —

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Allowed values are: TIMECREATED, DISPLAYNAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Allowed values are: ASC, DESC

Returns:

(Response) —

A Response object with data of type ContainerImageSignatureCollection

# File 'lib/oci/artifacts/artifacts_client.rb', line 1326

def list_container_image_signatures(compartment_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#list_container_image_signatures.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_container_image_signatures." if compartment_id.nil?

  if opts[:signing_algorithm] && !%w[SHA_224_RSA_PKCS_PSS SHA_256_RSA_PKCS_PSS SHA_384_RSA_PKCS_PSS SHA_512_RSA_PKCS_PSS].include?(opts[:signing_algorithm])
    raise 'Invalid value for "signing_algorithm", must be one of SHA_224_RSA_PKCS_PSS, SHA_256_RSA_PKCS_PSS, SHA_384_RSA_PKCS_PSS, SHA_512_RSA_PKCS_PSS.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/container/imageSignatures'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:imageId] = opts[:image_id] if opts[:image_id]
  query_params[:repositoryId] = opts[:repository_id] if opts[:repository_id]
  query_params[:repositoryName] = opts[:repository_name] if opts[:repository_name]
  query_params[:imageDigest] = opts[:image_digest] if opts[:image_digest]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:kmsKeyId] = opts[:kms_key_id] if opts[:kms_key_id]
  query_params[:kmsKeyVersionId] = opts[:kms_key_version_id] if opts[:kms_key_version_id]
  query_params[:signingAlgorithm] = opts[:signing_algorithm] if opts[:signing_algorithm]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#list_container_image_signatures') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImageSignatureCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_container_images(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_container_images API.

List container images in a compartment.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:compartment_id_in_subtree (BOOLEAN) —

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).
:display_name (String) —

A filter to return only resources that match the given display name exactly.
:image_id (String) —

A filter to return a container image summary only for the specified container image OCID.
:is_versioned (BOOLEAN) —

A filter to return container images based on whether there are any associated versions.
:repository_id (String) —

A filter to return container images only for the specified container repository OCID.
:repository_name (String) —

A filter to return container images or container image signatures that match the repository name.

Example: foo or foo*
:version (String) —

A filter to return container images that match the version.

Example: foo or foo*
:lifecycle_state (String) —

A filter to return only resources that match the given lifecycle state name exactly.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: 50
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:sort_by (String) —

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Allowed values are: TIMECREATED, DISPLAYNAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Allowed values are: ASC, DESC

Returns:

(Response) —

A Response object with data of type ContainerImageCollection

# File 'lib/oci/artifacts/artifacts_client.rb', line 1455

def list_container_images(compartment_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#list_container_images.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_container_images." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/container/images'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:imageId] = opts[:image_id] if opts[:image_id]
  query_params[:isVersioned] = opts[:is_versioned] if !opts[:is_versioned].nil?
  query_params[:repositoryId] = opts[:repository_id] if opts[:repository_id]
  query_params[:repositoryName] = opts[:repository_name] if opts[:repository_name]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#list_container_images') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_container_repositories(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_container_repositories API.

List container repositories in a compartment.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:compartment_id_in_subtree (BOOLEAN) —

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).
:repository_id (String) —

A filter to return container images only for the specified container repository OCID.
:display_name (String) —

A filter to return only resources that match the given display name exactly.
:is_public (BOOLEAN) —

A filter to return resources that match the isPublic value.
:lifecycle_state (String) —

A filter to return only resources that match the given lifecycle state name exactly.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: 50
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:sort_by (String) —

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Allowed values are: TIMECREATED, DISPLAYNAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Allowed values are: ASC, DESC

Returns:

(Response) —

A Response object with data of type ContainerRepositoryCollection

# File 'lib/oci/artifacts/artifacts_client.rb', line 1569

def list_container_repositories(compartment_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#list_container_repositories.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_container_repositories." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/container/repositories'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:repositoryId] = opts[:repository_id] if opts[:repository_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isPublic] = opts[:is_public] if !opts[:is_public].nil?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#list_container_repositories') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerRepositoryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_generic_artifacts(compartment_id, repository_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_generic_artifacts API.

Lists artifacts in the specified repository.

Parameters:

compartment_id (String) —

The OCID of the compartment.
repository_id (String) —

A filter to return the artifacts only for the specified repository OCID.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:id (String) —

A filter to return the resources for the specified OCID.
:display_name (String) —

A filter to return only resources that match the given display name exactly.
:artifact_path (String) —

Filter results by a prefix for the artifactPath and and return artifacts that begin with the specified prefix in their path.
:version (String) —

Filter results by a prefix for version and return artifacts that that begin with the specified prefix in their version.
:sha256 (String) —

Filter results by a specified SHA256 digest for the artifact.
:lifecycle_state (String) —

A filter to return only resources that match the given lifecycle state name exactly.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: 50
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:sort_by (String) —

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Allowed values are: TIMECREATED, DISPLAYNAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Allowed values are: ASC, DESC

Returns:

(Response) —

A Response object with data of type GenericArtifactCollection

# File 'lib/oci/artifacts/artifacts_client.rb', line 1680

def list_generic_artifacts(compartment_id, repository_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#list_generic_artifacts.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_generic_artifacts." if compartment_id.nil?
  raise "Missing the required parameter 'repository_id' when calling list_generic_artifacts." if repository_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/generic/artifacts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:repositoryId] = repository_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:artifactPath] = opts[:artifact_path] if opts[:artifact_path]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:sha256] = opts[:sha256] if opts[:sha256]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#list_generic_artifacts') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::GenericArtifactCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_repositories(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_repositories API.

Lists repositories in the specified compartment.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:id (String) —

A filter to return the resources for the specified OCID.
:display_name (String) —

A filter to return only resources that match the given display name exactly.
:is_immutable (BOOLEAN) —

A filter to return resources that match the isImmutable value.
:lifecycle_state (String) —

A filter to return only resources that match the given lifecycle state name exactly.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: 50
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:sort_by (String) —

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Allowed values are: TIMECREATED, DISPLAYNAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Allowed values are: ASC, DESC

Returns:

(Response) —

A Response object with data of type RepositoryCollection

# File 'lib/oci/artifacts/artifacts_client.rb', line 1788

def list_repositories(compartment_id, opts = {})
  logger.debug 'Calling operation ArtifactsClient#list_repositories.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_repositories." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/repositories'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isImmutable] = opts[:is_immutable] if !opts[:is_immutable].nil?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#list_repositories') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::RepositoryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ `Logger`

Returns The logger for this client. May be nil.

Returns:

(Logger) —

The logger for this client. May be nil.



95
96
97

# File 'lib/oci/artifacts/artifacts_client.rb', line 95

def logger
  @api_client.config.logger
end

#remove_container_version(image_id, remove_container_version_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use remove_container_version API.

Remove version from container image.

Parameters:

image_id (String) —

The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID
remove_container_version_details (OCI::Artifacts::Models::RemoveContainerVersionDetails) —

Remove version details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

(Response) —

A Response object with data of type ContainerImage

# File 'lib/oci/artifacts/artifacts_client.rb', line 1874

def remove_container_version(image_id, remove_container_version_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#remove_container_version.' if logger

  raise "Missing the required parameter 'image_id' when calling remove_container_version." if image_id.nil?
  raise "Missing the required parameter 'remove_container_version_details' when calling remove_container_version." if remove_container_version_details.nil?
  raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id)

  path = '/container/images/{imageId}/actions/removeVersion'.sub('{imageId}', image_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_container_version_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#remove_container_version') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#restore_container_image(image_id, restore_container_image_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use restore_container_image API.

Restore a container image.

Parameters:

image_id (String) —

The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID
restore_container_image_details (OCI::Artifacts::Models::RestoreContainerImageDetails) —

Restore container image details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

(Response) —

A Response object with data of type ContainerImage

# File 'lib/oci/artifacts/artifacts_client.rb', line 1948

def restore_container_image(image_id, restore_container_image_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#restore_container_image.' if logger

  raise "Missing the required parameter 'image_id' when calling restore_container_image." if image_id.nil?
  raise "Missing the required parameter 'restore_container_image_details' when calling restore_container_image." if restore_container_image_details.nil?
  raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id)

  path = '/container/images/{imageId}/actions/restore'.sub('{imageId}', image_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(restore_container_image_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#restore_container_image') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_container_configuration(compartment_id, update_container_configuration_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_container_configuration API.

Update container configuration.

Parameters:

compartment_id (String) —

The OCID of the compartment.
update_container_configuration_details (OCI::Artifacts::Models::UpdateContainerConfigurationDetails) —

Update container configuration details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ContainerConfiguration

# File 'lib/oci/artifacts/artifacts_client.rb', line 2013

def update_container_configuration(compartment_id, update_container_configuration_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#update_container_configuration.' if logger

  raise "Missing the required parameter 'compartment_id' when calling update_container_configuration." if compartment_id.nil?
  raise "Missing the required parameter 'update_container_configuration_details' when calling update_container_configuration." if update_container_configuration_details.nil?

  path = '/container/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_container_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#update_container_configuration') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_container_image(image_id, update_container_image_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_container_image API.

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

Parameters:

image_id (String) —

The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID
update_container_image_details (OCI::Artifacts::Models::UpdateContainerImageDetails) —

Update container image details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ContainerImage

# File 'lib/oci/artifacts/artifacts_client.rb', line 2079

def update_container_image(image_id, update_container_image_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#update_container_image.' if logger

  raise "Missing the required parameter 'image_id' when calling update_container_image." if image_id.nil?
  raise "Missing the required parameter 'update_container_image_details' when calling update_container_image." if update_container_image_details.nil?
  raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id)

  path = '/container/images/{imageId}'.sub('{imageId}', image_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_container_image_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#update_container_image') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_container_image_signature(image_signature_id, update_container_image_signature_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_container_image_signature API.

Modify the properties of a container image signature. Avoid entering confidential information.

Parameters:

image_signature_id (String) —

The OCID of the container image signature.

Example: ocid1.containersignature.oc1..exampleuniqueID
update_container_image_signature_details (OCI::Artifacts::Models::UpdateContainerImageSignatureDetails) —

Update container image signature details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

(Response) —

A Response object with data of type ContainerImageSignature

# File 'lib/oci/artifacts/artifacts_client.rb', line 2145

def update_container_image_signature(image_signature_id, update_container_image_signature_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#update_container_image_signature.' if logger

  raise "Missing the required parameter 'image_signature_id' when calling update_container_image_signature." if image_signature_id.nil?
  raise "Missing the required parameter 'update_container_image_signature_details' when calling update_container_image_signature." if update_container_image_signature_details.nil?
  raise "Parameter value for 'image_signature_id' must not be blank" if OCI::Internal::Util.blank_string?(image_signature_id)

  path = '/container/imageSignatures/{imageSignatureId}'.sub('{imageSignatureId}', image_signature_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_container_image_signature_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#update_container_image_signature') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerImageSignature'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_container_repository(repository_id, update_container_repository_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_container_repository API.

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

Parameters:

repository_id (String) —

The OCID of the container repository.

Example: ocid1.containerrepo.oc1..exampleuniqueID
update_container_repository_details (OCI::Artifacts::Models::UpdateContainerRepositoryDetails) —

Update container repository details.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ContainerRepository

# File 'lib/oci/artifacts/artifacts_client.rb', line 2211

def update_container_repository(repository_id, update_container_repository_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#update_container_repository.' if logger

  raise "Missing the required parameter 'repository_id' when calling update_container_repository." if repository_id.nil?
  raise "Missing the required parameter 'update_container_repository_details' when calling update_container_repository." if update_container_repository_details.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/container/repositories/{repositoryId}'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_container_repository_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#update_container_repository') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::ContainerRepository'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_generic_artifact(artifact_id, update_generic_artifact_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_generic_artifact API.

Updates the artifact with the specified OCID. You can only update the tags of an artifact.

Parameters:

artifact_id (String) —

The OCID of the artifact.

Example: ocid1.genericartifact.oc1..exampleuniqueID
update_generic_artifact_details (OCI::Artifacts::Models::UpdateGenericArtifactDetails) —

Updates the artifact with the specified OCID. You can only update the tags of an artifact.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type GenericArtifact

# File 'lib/oci/artifacts/artifacts_client.rb', line 2277

def update_generic_artifact(artifact_id, update_generic_artifact_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#update_generic_artifact.' if logger

  raise "Missing the required parameter 'artifact_id' when calling update_generic_artifact." if artifact_id.nil?
  raise "Missing the required parameter 'update_generic_artifact_details' when calling update_generic_artifact." if update_generic_artifact_details.nil?
  raise "Parameter value for 'artifact_id' must not be blank" if OCI::Internal::Util.blank_string?(artifact_id)

  path = '/generic/artifacts/{artifactId}'.sub('{artifactId}', artifact_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_generic_artifact_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#update_generic_artifact') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::GenericArtifact'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_generic_artifact_by_path(repository_id, artifact_path, version, update_generic_artifact_by_path_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_generic_artifact_by_path API.

Updates an artifact with a specified artifactPath and version. You can only update the tags of an artifact.

Parameters:

repository_id (String) —

The OCID of the repository.

Example: ocid1.artifactrepository.oc1..exampleuniqueID
artifact_path (String) —

A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.

Example: project01/my-web-app/artifact-abc
version (String) —

A user-defined string to describe the artifact version.

Example: 1.1.2 or 1.2-beta-2
update_generic_artifact_by_path_details (OCI::Artifacts::Models::UpdateGenericArtifactByPathDetails) —

Updates an artifact with a specified artifactPath and version. You can only update the tags of an artifact.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type GenericArtifact

# File 'lib/oci/artifacts/artifacts_client.rb', line 2351

def update_generic_artifact_by_path(repository_id, artifact_path, version, update_generic_artifact_by_path_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#update_generic_artifact_by_path.' if logger

  raise "Missing the required parameter 'repository_id' when calling update_generic_artifact_by_path." if repository_id.nil?
  raise "Missing the required parameter 'artifact_path' when calling update_generic_artifact_by_path." if artifact_path.nil?
  raise "Missing the required parameter 'version' when calling update_generic_artifact_by_path." if version.nil?
  raise "Missing the required parameter 'update_generic_artifact_by_path_details' when calling update_generic_artifact_by_path." if update_generic_artifact_by_path_details.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)
  raise "Parameter value for 'artifact_path' must not be blank" if OCI::Internal::Util.blank_string?(artifact_path)
  raise "Parameter value for 'version' must not be blank" if OCI::Internal::Util.blank_string?(version)

  path = '/generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}'.sub('{repositoryId}', repository_id.to_s).sub('{artifactPath}', artifact_path.to_s).sub('{version}', version.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_generic_artifact_by_path_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#update_generic_artifact_by_path') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::GenericArtifact'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_repository(repository_id, update_repository_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_repository API.

Updates the properties of a repository. You can update the displayName and description properties.

Parameters:

repository_id (String) —

The OCID of the repository.

Example: ocid1.artifactrepository.oc1..exampleuniqueID
update_repository_details (OCI::Artifacts::Models::UpdateRepositoryDetails) —

Updates the properties of a repository.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type Repository

# File 'lib/oci/artifacts/artifacts_client.rb', line 2421

def update_repository(repository_id, update_repository_details, opts = {})
  logger.debug 'Calling operation ArtifactsClient#update_repository.' if logger

  raise "Missing the required parameter 'repository_id' when calling update_repository." if repository_id.nil?
  raise "Missing the required parameter 'update_repository_details' when calling update_repository." if update_repository_details.nil?
  raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id)

  path = '/repositories/{repositoryId}'.sub('{repositoryId}', repository_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_repository_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ArtifactsClient#update_repository') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Artifacts::Models::Repository'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Class: OCI::Artifacts::ArtifactsClient

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ArtifactsClient

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

Instance Method Details

#change_container_repository_compartment(repository_id, change_container_repository_compartment_details, opts = {}) ⇒ Response

#change_repository_compartment(repository_id, change_repository_compartment_details, opts = {}) ⇒ Response

#create_container_image_signature(create_container_image_signature_details, opts = {}) ⇒ Response

#create_container_repository(create_container_repository_details, opts = {}) ⇒ Response

#create_repository(create_repository_details, opts = {}) ⇒ Response

#delete_container_image(image_id, opts = {}) ⇒ Response

#delete_container_image_signature(image_signature_id, opts = {}) ⇒ Response

#delete_container_repository(repository_id, opts = {}) ⇒ Response

#delete_generic_artifact(artifact_id, opts = {}) ⇒ Response

#delete_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ Response

#delete_repository(repository_id, opts = {}) ⇒ Response

#get_container_configuration(compartment_id, opts = {}) ⇒ Response

#get_container_image(image_id, opts = {}) ⇒ Response

#get_container_image_signature(image_signature_id, opts = {}) ⇒ Response

#get_container_repository(repository_id, opts = {}) ⇒ Response

#get_generic_artifact(artifact_id, opts = {}) ⇒ Response

#get_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ Response

#get_repository(repository_id, opts = {}) ⇒ Response

#list_container_image_signatures(compartment_id, opts = {}) ⇒ Response

#list_container_images(compartment_id, opts = {}) ⇒ Response

#list_container_repositories(compartment_id, opts = {}) ⇒ Response

#list_generic_artifacts(compartment_id, repository_id, opts = {}) ⇒ Response

#list_repositories(compartment_id, opts = {}) ⇒ Response

#logger ⇒ Logger

#remove_container_version(image_id, remove_container_version_details, opts = {}) ⇒ Response

#restore_container_image(image_id, restore_container_image_details, opts = {}) ⇒ Response

#update_container_configuration(compartment_id, update_container_configuration_details, opts = {}) ⇒ Response

#update_container_image(image_id, update_container_image_details, opts = {}) ⇒ Response

#update_container_image_signature(image_signature_id, update_container_image_signature_details, opts = {}) ⇒ Response

#update_container_repository(repository_id, update_container_repository_details, opts = {}) ⇒ Response

#update_generic_artifact(artifact_id, update_generic_artifact_details, opts = {}) ⇒ Response

#update_generic_artifact_by_path(repository_id, artifact_path, version, update_generic_artifact_by_path_details, opts = {}) ⇒ Response

#update_repository(repository_id, update_repository_details, opts = {}) ⇒ Response

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ `ArtifactsClient`

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

#retry_config ⇒ `OCI::Retry::RetryConfig` (readonly)

#change_container_repository_compartment(repository_id, change_container_repository_compartment_details, opts = {}) ⇒ `Response`

#change_repository_compartment(repository_id, change_repository_compartment_details, opts = {}) ⇒ `Response`

#create_container_image_signature(create_container_image_signature_details, opts = {}) ⇒ `Response`

#create_container_repository(create_container_repository_details, opts = {}) ⇒ `Response`

#create_repository(create_repository_details, opts = {}) ⇒ `Response`

#delete_container_image(image_id, opts = {}) ⇒ `Response`

#delete_container_image_signature(image_signature_id, opts = {}) ⇒ `Response`

#delete_container_repository(repository_id, opts = {}) ⇒ `Response`

#delete_generic_artifact(artifact_id, opts = {}) ⇒ `Response`

#delete_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ `Response`

#delete_repository(repository_id, opts = {}) ⇒ `Response`

#get_container_configuration(compartment_id, opts = {}) ⇒ `Response`

#get_container_image(image_id, opts = {}) ⇒ `Response`

#get_container_image_signature(image_signature_id, opts = {}) ⇒ `Response`

#get_container_repository(repository_id, opts = {}) ⇒ `Response`

#get_generic_artifact(artifact_id, opts = {}) ⇒ `Response`

#get_generic_artifact_by_path(repository_id, artifact_path, version, opts = {}) ⇒ `Response`

#get_repository(repository_id, opts = {}) ⇒ `Response`

#list_container_image_signatures(compartment_id, opts = {}) ⇒ `Response`

#list_container_images(compartment_id, opts = {}) ⇒ `Response`

#list_container_repositories(compartment_id, opts = {}) ⇒ `Response`

#list_generic_artifacts(compartment_id, repository_id, opts = {}) ⇒ `Response`

#list_repositories(compartment_id, opts = {}) ⇒ `Response`

#logger ⇒ `Logger`

#remove_container_version(image_id, remove_container_version_details, opts = {}) ⇒ `Response`

#restore_container_image(image_id, restore_container_image_details, opts = {}) ⇒ `Response`

#update_container_configuration(compartment_id, update_container_configuration_details, opts = {}) ⇒ `Response`

#update_container_image(image_id, update_container_image_details, opts = {}) ⇒ `Response`

#update_container_image_signature(image_signature_id, update_container_image_signature_details, opts = {}) ⇒ `Response`

#update_container_repository(repository_id, update_container_repository_details, opts = {}) ⇒ `Response`

#update_generic_artifact(artifact_id, update_generic_artifact_details, opts = {}) ⇒ `Response`

#update_generic_artifact_by_path(repository_id, artifact_path, version, update_generic_artifact_by_path_details, opts = {}) ⇒ `Response`

#update_repository(repository_id, update_repository_details, opts = {}) ⇒ `Response`