DevopsClient

class oci.devops.DevopsClient(config, **kwargs)

Use the DevOps APIs to create a DevOps project to group the pipelines, add reference to target deployment environments, add artifacts to deploy, and create deployment pipelines needed to deploy your software.

Methods

__init__(config, **kwargs) Creates a new service client
approve_deployment(deployment_id, …) Submit stage approval.
cancel_deployment(deployment_id, …) Cancels a deployment resource by identifier.
change_project_compartment(project_id, …) Moves a project resource from one compartment OCID to another.
create_deploy_artifact(…) Creates a new deployment artifact.
create_deploy_environment(…) Creates a new deployment environment.
create_deploy_pipeline(…) Creates a new deployment pipeline.
create_deploy_stage(…) Creates a new deployment stage.
create_deployment(create_deployment_details, …) Creates a new deployment.
create_project(create_project_details, **kwargs) Creates a new project.
delete_deploy_artifact(deploy_artifact_id, …) Deletes a deployment artifact resource by identifier.
delete_deploy_environment(…) Deletes a deployment environment resource by identifier.
delete_deploy_pipeline(deploy_pipeline_id, …) Deletes a deployment pipeline resource by identifier.
delete_deploy_stage(deploy_stage_id, **kwargs) Deletes a deployment stage resource by identifier.
delete_project(project_id, **kwargs) Deletes a project resource by identifier
get_deploy_artifact(deploy_artifact_id, **kwargs) Retrieves a deployment artifact by identifier.
get_deploy_environment(…) Retrieves a deployment environment by identifier.
get_deploy_pipeline(deploy_pipeline_id, **kwargs) Retrieves a deployment pipeline by identifier.
get_deploy_stage(deploy_stage_id, **kwargs) Retrieves a deployment stage by identifier.
get_deployment(deployment_id, **kwargs) Retrieves a deployment by identifier.
get_project(project_id, **kwargs) Retrieves a project by identifier.
get_work_request(work_request_id, **kwargs) Retrieves the status of the work request with the given ID.
list_deploy_artifacts(**kwargs) Returns a list of deployment artifacts.
list_deploy_environments(**kwargs) Returns a list of deployment environments.
list_deploy_pipelines(**kwargs) Returns a list of deployment pipelines.
list_deploy_stages(**kwargs) Retrieves a list of deployment stages.
list_deployments(**kwargs) Returns a list of deployments.
list_projects(compartment_id, **kwargs) Returns a list of projects.
list_work_request_errors(work_request_id, …) Returns a list of errors for a given work request.
list_work_request_logs(work_request_id, **kwargs) Returns a list of logs for a given work request.
list_work_requests(compartment_id, **kwargs) Lists the work requests in a compartment.
update_deploy_artifact(deploy_artifact_id, …) Updates the deployment artifact.
update_deploy_environment(…) Updates the deployment environment.
update_deploy_pipeline(deploy_pipeline_id, …) Updates the deployment pipeline.
update_deploy_stage(deploy_stage_id, …) Updates the deployment stage.
update_deployment(deployment_id, …) Updates the deployment.
update_project(project_id, …) Updates the project.
__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.
approve_deployment(deployment_id, approve_deployment_details, **kwargs)

Submit stage approval.

Parameters:
  • deployment_id (str) – (required) Unique deployment identifier.
  • approve_deployment_details (oci.devops.models.ApproveDeploymentDetails) – (required) The stage information for approval.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • 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 Deployment

Return type:

Response

Example:

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

cancel_deployment(deployment_id, cancel_deployment_details, **kwargs)

Cancels a deployment resource by identifier.

Parameters:
  • deployment_id (str) – (required) Unique deployment identifier.
  • cancel_deployment_details (oci.devops.models.CancelDeploymentDetails) – (required) The information regarding the deployment to be canceled.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • 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 Deployment

Return type:

Response

Example:

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

change_project_compartment(project_id, change_project_compartment_details, **kwargs)

Moves a project resource from one compartment OCID to another.

Parameters:
  • project_id (str) – (required) Unique project identifier.
  • change_project_compartment_details (oci.devops.models.ChangeProjectCompartmentDetails) – (required) The information to be updated.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • 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 None

Return type:

Response

Example:

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

create_deploy_artifact(create_deploy_artifact_details, **kwargs)

Creates a new deployment artifact.

Parameters:
  • create_deploy_artifact_details (oci.devops.models.CreateDeployArtifactDetails) – (required) Details for the new deployment artifact.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployArtifact

Return type:

Response

Example:

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

create_deploy_environment(create_deploy_environment_details, **kwargs)

Creates a new deployment environment.

Parameters:
  • create_deploy_environment_details (oci.devops.models.CreateDeployEnvironmentDetails) – (required) Details for the new deployment environment.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployEnvironment

Return type:

Response

Example:

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

create_deploy_pipeline(create_deploy_pipeline_details, **kwargs)

Creates a new deployment pipeline.

Parameters:
  • create_deploy_pipeline_details (oci.devops.models.CreateDeployPipelineDetails) – (required) Details for the new deployment pipeline.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployPipeline

Return type:

Response

Example:

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

create_deploy_stage(create_deploy_stage_details, **kwargs)

Creates a new deployment stage.

Parameters:
  • create_deploy_stage_details (oci.devops.models.CreateDeployStageDetails) – (required) Details for the new DeployStage.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployStage

Return type:

Response

Example:

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

create_deployment(create_deployment_details, **kwargs)

Creates a new deployment.

Parameters:
  • create_deployment_details (oci.devops.models.CreateDeploymentDetails) – (required) Details for the new deployment.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 Deployment

Return type:

Response

Example:

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

create_project(create_project_details, **kwargs)

Creates a new project.

Parameters:
  • create_project_details (oci.devops.models.CreateProjectDetails) – (required) Details for the new project.
  • opc_retry_token (str) – (optional) 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 earlier 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 might be rejected.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 Project

Return type:

Response

Example:

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

delete_deploy_artifact(deploy_artifact_id, **kwargs)

Deletes a deployment artifact resource by identifier.

Parameters:
  • deploy_artifact_id (str) – (required) Unique artifact identifier.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 None

Return type:

Response

Example:

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

delete_deploy_environment(deploy_environment_id, **kwargs)

Deletes a deployment environment resource by identifier.

Parameters:
  • deploy_environment_id (str) – (required) Unique environment identifier.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 None

Return type:

Response

Example:

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

delete_deploy_pipeline(deploy_pipeline_id, **kwargs)

Deletes a deployment pipeline resource by identifier.

Parameters:
  • deploy_pipeline_id (str) – (required) Unique pipeline identifier.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 None

Return type:

Response

Example:

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

delete_deploy_stage(deploy_stage_id, **kwargs)

Deletes a deployment stage resource by identifier.

Parameters:
  • deploy_stage_id (str) – (required) Unique stage identifier.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 None

Return type:

Response

Example:

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

delete_project(project_id, **kwargs)

Deletes a project resource by identifier

Parameters:
  • project_id (str) – (required) Unique project identifier.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 None

Return type:

Response

Example:

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

get_deploy_artifact(deploy_artifact_id, **kwargs)

Retrieves a deployment artifact by identifier.

Parameters:
  • deploy_artifact_id (str) – (required) Unique artifact identifier.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployArtifact

Return type:

Response

Example:

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

get_deploy_environment(deploy_environment_id, **kwargs)

Retrieves a deployment environment by identifier.

Parameters:
  • deploy_environment_id (str) – (required) Unique environment identifier.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployEnvironment

Return type:

Response

Example:

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

get_deploy_pipeline(deploy_pipeline_id, **kwargs)

Retrieves a deployment pipeline by identifier.

Parameters:
  • deploy_pipeline_id (str) – (required) Unique pipeline identifier.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployPipeline

Return type:

Response

Example:

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

get_deploy_stage(deploy_stage_id, **kwargs)

Retrieves a deployment stage by identifier.

Parameters:
  • deploy_stage_id (str) – (required) Unique stage identifier.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployStage

Return type:

Response

Example:

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

get_deployment(deployment_id, **kwargs)

Retrieves a deployment by identifier.

Parameters:
  • deployment_id (str) – (required) Unique deployment identifier.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 Deployment

Return type:

Response

Example:

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

get_project(project_id, **kwargs)

Retrieves a project by identifier.

Parameters:
  • project_id (str) – (required) Unique project identifier.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 Project

Return type:

Response

Example:

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

get_work_request(work_request_id, **kwargs)

Retrieves the status of the work request with the given ID.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous work request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 WorkRequest

Return type:

Response

Example:

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

list_deploy_artifacts(**kwargs)

Returns a list of deployment artifacts.

Parameters:
  • id (str) – (optional) Unique identifier or OCID for listing a single resource by ID.
  • project_id (str) – (optional) unique project identifier
  • compartment_id (str) – (optional) The OCID of the compartment in which to list resources.
  • lifecycle_state (str) –

    (optional) A filter to return only DeployArtifacts that matches the given lifecycleState.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployArtifactCollection

Return type:

Response

Example:

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

list_deploy_environments(**kwargs)

Returns a list of deployment environments.

Parameters:
  • project_id (str) – (optional) unique project identifier
  • compartment_id (str) – (optional) The OCID of the compartment in which to list resources.
  • id (str) – (optional) Unique identifier or OCID for listing a single resource by ID.
  • lifecycle_state (str) –

    (optional) A filter to return only DeployEnvironments that matches the given lifecycleState.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployEnvironmentCollection

Return type:

Response

Example:

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

list_deploy_pipelines(**kwargs)

Returns a list of deployment pipelines.

Parameters:
  • id (str) – (optional) Unique identifier or OCID for listing a single resource by ID.
  • project_id (str) – (optional) unique project identifier
  • compartment_id (str) – (optional) The OCID of the compartment in which to list resources.
  • lifecycle_state (str) –

    (optional) A filter to return only DeployPipelines that matches the given lifecycleState.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployPipelineCollection

Return type:

Response

Example:

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

list_deploy_stages(**kwargs)

Retrieves a list of deployment stages.

Parameters:
  • id (str) – (optional) Unique identifier or OCID for listing a single resource by ID.
  • deploy_pipeline_id (str) – (optional) The ID of the parent pipeline.
  • compartment_id (str) – (optional) The OCID of the compartment in which to list resources.
  • lifecycle_state (str) –

    (optional) A filter to return only deployment stages that matches the given lifecycle state.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployStageCollection

Return type:

Response

Example:

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

list_deployments(**kwargs)

Returns a list of deployments.

Parameters:
  • deploy_pipeline_id (str) – (optional) The ID of the parent pipeline.
  • id (str) – (optional) Unique identifier or OCID for listing a single resource by ID.
  • compartment_id (str) – (optional) The OCID of the compartment in which to list resources.
  • project_id (str) – (optional) unique project identifier
  • lifecycle_state (str) –

    (optional) A filter to return only Deployments that matches the given lifecycleState.

    Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.
  • time_created_less_than (datetime) –

    (optional) Search for DevOps resources that were created before a specific date. Specifying this parameter corresponding to timeCreatedLessThan parameter will retrieve all assessments created before the specified created date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC3339.

  • time_created_greater_than_or_equal_to (datetime) –

    (optional) Search for DevOps resources that were created after a specific date. Specifying this parameter corresponding to timeCreatedGreaterThanOrEqualTo parameter will retrieve all security assessments created after the specified created date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC3339.

  • 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 DeploymentCollection

Return type:

Response

Example:

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

list_projects(compartment_id, **kwargs)

Returns a list of projects.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment in which to list resources.
  • id (str) – (optional) Unique identifier or OCID for listing a single resource by ID.
  • lifecycle_state (str) –

    (optional) A filter to return only Projects that matches the given lifecycleState.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • name (str) – (optional) A filter to return only resources that match the entire name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 ProjectCollection

Return type:

Response

Example:

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

list_work_request_errors(work_request_id, **kwargs)

Returns a list of errors for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous work request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order can be provided. Default sort order is descending and is based on the timeAccepted field.

    Allowed values are: “timeAccepted”

  • 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 WorkRequestErrorCollection

Return type:

Response

Example:

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

list_work_request_logs(work_request_id, **kwargs)

Returns a list of logs for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous work request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order can be provided. Default sort order is descending and is based on the timeAccepted field.

    Allowed values are: “timeAccepted”

  • 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 WorkRequestLogEntryCollection

Return type:

Response

Example:

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

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment in which to list resources.
  • work_request_id (str) – (optional) The ID of the asynchronous work request.
  • status (str) –

    (optional) A filter to return only resources where the lifecycle state matches the given operation status.

    Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

  • resource_id (str) – (optional) The ID of the resource affected by the work request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_order (str) –

    (optional) The sort order to use. Use either ascending or descending.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order can be provided. Default sort order is descending and is based on the timeAccepted field.

    Allowed values are: “timeAccepted”

  • 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 WorkRequestCollection

Return type:

Response

Example:

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

update_deploy_artifact(deploy_artifact_id, update_deploy_artifact_details, **kwargs)

Updates the deployment artifact.

Parameters:
  • deploy_artifact_id (str) – (required) Unique artifact identifier.
  • update_deploy_artifact_details (oci.devops.models.UpdateDeployArtifactDetails) – (required) The information to be updated.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployArtifact

Return type:

Response

Example:

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

update_deploy_environment(deploy_environment_id, update_deploy_environment_details, **kwargs)

Updates the deployment environment.

Parameters:
  • deploy_environment_id (str) – (required) Unique environment identifier.
  • update_deploy_environment_details (oci.devops.models.UpdateDeployEnvironmentDetails) – (required) The information to be updated.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployEnvironment

Return type:

Response

Example:

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

update_deploy_pipeline(deploy_pipeline_id, update_deploy_pipeline_details, **kwargs)

Updates the deployment pipeline.

Parameters:
  • deploy_pipeline_id (str) – (required) Unique pipeline identifier.
  • update_deploy_pipeline_details (oci.devops.models.UpdateDeployPipelineDetails) – (required) The information to be updated.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployPipeline

Return type:

Response

Example:

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

update_deploy_stage(deploy_stage_id, update_deploy_stage_details, **kwargs)

Updates the deployment stage.

Parameters:
  • deploy_stage_id (str) – (required) Unique stage identifier.
  • update_deploy_stage_details (oci.devops.models.UpdateDeployStageDetails) – (required) The information to be updated.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 DeployStage

Return type:

Response

Example:

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

update_deployment(deployment_id, update_deployment_details, **kwargs)

Updates the deployment.

Parameters:
  • deployment_id (str) – (required) Unique deployment identifier.
  • update_deployment_details (oci.devops.models.UpdateDeploymentDetails) – (required) The information to be updated.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 Deployment

Return type:

Response

Example:

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

update_project(project_id, update_project_details, **kwargs)

Updates the project.

Parameters:
  • project_id (str) – (required) Unique project identifier.
  • update_project_details (oci.devops.models.UpdateProjectDetails) – (required) The information to be updated.
  • 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.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the 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 Project

Return type:

Response

Example:

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