GenericArtifactsContentClient

class oci.generic_artifacts_content.GenericArtifactsContentClient(config, **kwargs)

API covering the Generic Artifacts Service content Use this API to put and get generic artifact content.

Methods

__init__(config, **kwargs) Creates a new service client
get_generic_artifact_content(artifact_id, …) Gets the specified artifact’s content.
get_generic_artifact_content_by_path(…) Gets the content of an artifact with a specified artifactPath and version.
put_generic_artifact_content_by_path(…) Uploads an artifact.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client will not have circuit breakers enabled by default, users can use their own circuit breaker strategy or the convenient DEFAULT_CIRCUIT_BREAKER_STRATEGY provided by the SDK to enable it. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
get_generic_artifact_content(artifact_id, **kwargs)

Gets the specified artifact’s content.

Parameters:
  • artifact_id (str) –

    (required) The OCID of the artifact.

    Example: ocid1.genericartifact.oc1..exampleuniqueID

  • opc_request_id (str) –

    (optional) Unique Oracle-assigned request ID

    Example: bxxxxxxx-fxxx-4xxx-9xxx-bxxxxxxxxxxx If you contact Oracle about a request, provide this request ID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

get_generic_artifact_content_by_path(repository_id, artifact_path, version, **kwargs)

Gets the content of an artifact with a specified artifactPath and version.

Parameters:
  • repository_id (str) –

    (required) The OCID of the repository.

    Example: ocid1.repository.oc1..exampleuniqueID

  • artifact_path (str) –

    (required) 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 (str) –

    (required) A user-defined string to describe the artifact version.

    Example: 1.1.2 or 1.2-beta-2

  • opc_request_id (str) –

    (optional) Unique Oracle-assigned request ID

    Example: bxxxxxxx-fxxx-4xxx-9xxx-bxxxxxxxxxxx If you contact Oracle about a request, provide this request ID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

put_generic_artifact_content_by_path(repository_id, artifact_path, version, generic_artifact_content_body, **kwargs)

Uploads an artifact. Provide artifactPath, version and content. Avoid entering confidential information when you define the path and version.

Parameters:
  • repository_id (str) –

    (required) The OCID of the repository.

    Example: ocid1.repository.oc1..exampleuniqueID

  • artifact_path (str) –

    (required) 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 (str) –

    (required) A user-defined string to describe the artifact version.

    Example: 1.1.2 or 1.2-beta-2

  • generic_artifact_content_body (stream) – (required) Uploads an artifact. Provide artifact path, version and content. Avoid entering confidential information when you define the path and version.
  • if_match (str) – (optional) 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. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.
  • opc_request_id (str) –

    (optional) Unique Oracle-assigned request ID

    Example: bxxxxxxx-fxxx-4xxx-9xxx-bxxxxxxxxxxx If you contact Oracle about a request, provide this request ID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • buffer_limit (int) –

    (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

    The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns:

A Response object with data of type GenericArtifact

Return type:

Response

Example:

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