DevopsClient¶

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

Use the DevOps API to create DevOps projects, configure code repositories, add artifacts to deploy, build and test software applications, configure target deployment environments, and deploy software applications. For more information, see [DevOps](/Content/devops/using/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`approve_deployment`(deployment_id, …)	Submit stage approval.
`cancel_build_run`(cancel_build_run_details, …)	Cancels the build run based on the build run ID provided in the request.
`cancel_deployment`(deployment_id, …)	Cancels a deployment resource by identifier.
`cancel_scheduled_cascading_project_deletion`(…)	Cascading operation that restores Project and child resources from a DELETING state to an active state
`change_project_compartment`(project_id, …)	Moves a project resource from one compartment OCID to another.
`create_build_pipeline`(…)	Creates a new build pipeline.
`create_build_pipeline_stage`(…)	Creates a new stage.
`create_build_run`(create_build_run_details, …)	Starts a build pipeline run for a predefined build pipeline.
`create_connection`(create_connection_details, …)	Creates a new connection.
`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.
`create_repository`(create_repository_details, …)	Creates a new repository.
`create_trigger`(create_trigger_details, **kwargs)	Creates a new trigger.
`delete_build_pipeline`(build_pipeline_id, …)	Deletes a build pipeline resource by identifier.
`delete_build_pipeline_stage`(…)	Deletes a stage based on the stage ID provided in the request.
`delete_connection`(connection_id, **kwargs)	Deletes a connection resource by identifier.
`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
`delete_ref`(repository_id, ref_name, **kwargs)	Deletes a Repository’s Ref by its name.
`delete_repository`(repository_id, **kwargs)	Deletes a repository resource by identifier.
`delete_trigger`(trigger_id, **kwargs)	Deletes a trigger resource by identifier.
`get_build_pipeline`(build_pipeline_id, **kwargs)	Retrieves a build pipeline by identifier.
`get_build_pipeline_stage`(…)	Retrieves a stage based on the stage ID provided in the request.
`get_build_run`(build_run_id, **kwargs)	Returns the details of a build run for a given build run ID.
`get_commit`(repository_id, commit_id, **kwargs)	Retrieves a repository’s commit by commit ID.
`get_commit_diff`(repository_id, …)	Compares two revisions for their differences.
`get_connection`(connection_id, **kwargs)	Retrieves a connection 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_file_diff`(repository_id, file_path, …)	Gets the line-by-line difference between file on different commits.
`get_mirror_record`(repository_id, …)	Returns either current mirror record or last successful mirror record for a specific mirror repository.
`get_object`(repository_id, **kwargs)	Retrieves blob of specific branch name/commit ID and file path.
`get_object_content`(repository_id, sha, **kwargs)	Retrieve contents of a specified object.
`get_project`(project_id, **kwargs)	Retrieves a project by identifier.
`get_ref`(repository_id, ref_name, **kwargs)	This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ‘/’.
`get_repo_file_diff`(repository_id, …)	Gets the line-by-line difference between file on different commits.
`get_repo_file_lines`(repository_id, revision, …)	Retrieve lines of a specified file.
`get_repository`(repository_id, **kwargs)	Retrieves a repository by identifier.
`get_repository_archive_content`(…)	Returns the archived repository information.
`get_repository_file_lines`(repository_id, …)	Retrieve lines of a specified file.
`get_trigger`(trigger_id, **kwargs)	Retrieves a trigger by identifier.
`get_work_request`(work_request_id, **kwargs)	Retrieves the status of the work request with the given ID.
`list_authors`(repository_id, **kwargs)	Retrieve a list of all the authors.
`list_build_pipeline_stages`(**kwargs)	Returns a list of all stages in a compartment or build pipeline.
`list_build_pipelines`(**kwargs)	Returns a list of build pipelines.
`list_build_runs`(**kwargs)	Returns a list of build run summary.
`list_commit_diffs`(repository_id, …)	Compares two revisions and lists the differences.
`list_commits`(repository_id, **kwargs)	Returns a list of commits.
`list_connections`(**kwargs)	Returns a list of connections.
`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_mirror_records`(repository_id, **kwargs)	Returns a list of mirror entry in history within 30 days.
`list_paths`(repository_id, **kwargs)	Retrieves a list of files and directories in a repository.
`list_projects`(compartment_id, **kwargs)	Returns a list of projects.
`list_refs`(repository_id, **kwargs)	Returns a list of references.
`list_repositories`(**kwargs)	Returns a list of repositories given a compartment ID or a project ID.
`list_triggers`(**kwargs)	Returns a list of triggers.
`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.
`mirror_repository`(repository_id, **kwargs)	Synchronize a mirrored repository to the latest version from external providers.
`put_repository_ref`(repository_id, ref_name, …)	Creates a new reference or updates an existing one.
`schedule_cascading_project_deletion`(…)	Cascading operation that marks Project and child DevOps resources in a DELETING state for a retention period
`update_build_pipeline`(build_pipeline_id, …)	Updates the build pipeline.
`update_build_pipeline_stage`(…)	Updates the stage based on the stage ID provided in the request.
`update_build_run`(build_run_id, …)	Updates the build run.
`update_connection`(connection_id, …)	Updates the connection.
`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.
`update_repository`(repository_id, …)	Updates the repository.
`update_trigger`(trigger_id, …)	Updates the trigger.
`validate_connection`(connection_id, **kwargs)	Return whether the credentials of the connection are valid.

__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 uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. 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.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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_build_run(cancel_build_run_details, build_run_id, **kwargs)¶

Cancels the build run based on the build run ID provided in the request.

Parameters:	cancel_build_run_details (oci.devops.models.CancelBuildRunDetails) – (required) Parameter details required to cancel a build run. build_run_id (str) – (required) Unique build run 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildRun`
Return type:	`Response`
Example:

Click here to see an example of how to use cancel_build_run 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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.

cancel_scheduled_cascading_project_deletion(project_id, **kwargs)¶

Cascading operation that restores Project and child resources from a DELETING state to an active state

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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use cancel_scheduled_cascading_project_deletion 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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_build_pipeline(create_build_pipeline_details, **kwargs)¶

Creates a new build pipeline.

Parameters:	create_build_pipeline_details (oci.devops.models.CreateBuildPipelineDetails) – (required) Details for the new build 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipeline`
Return type:	`Response`
Example:

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

create_build_pipeline_stage(create_build_pipeline_stage_details, **kwargs)¶

Creates a new stage.

Parameters:	create_build_pipeline_stage_details (oci.devops.models.CreateBuildPipelineStageDetails) – (required) Details for the new stage. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipelineStage`
Return type:	`Response`
Example:

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

create_build_run(create_build_run_details, **kwargs)¶

Starts a build pipeline run for a predefined build pipeline. Please ensure the completion of any work request for creation/updation of Build Pipeline before starting a Build Run.

Parameters:	create_build_run_details (oci.devops.models.CreateBuildRunDetails) – (required) Parameter details required to create a new build run. 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. 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildRun`
Return type:	`Response`
Example:

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

create_connection(create_connection_details, **kwargs)¶

Creates a new connection.

Parameters:	create_connection_details (oci.devops.models.CreateConnectionDetails) – (required) Details for the new connection. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use create_connection 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 deployment stage. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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.

create_repository(create_repository_details, **kwargs)¶

Creates a new repository.

Parameters:	create_repository_details (oci.devops.models.CreateRepositoryDetails) – (required) Details for the new repository. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Repository`
Return type:	`Response`
Example:

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

create_trigger(create_trigger_details, **kwargs)¶

Creates a new trigger.

Parameters:	create_trigger_details (oci.devops.models.CreateTriggerDetails) – (required) Details for the new trigger. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TriggerCreateResult`
Return type:	`Response`
Example:

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

delete_build_pipeline(build_pipeline_id, **kwargs)¶

Deletes a build pipeline resource by identifier.

Parameters:	build_pipeline_id (str) – (required) Unique build 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_build_pipeline_stage(build_pipeline_stage_id, **kwargs)¶

Deletes a stage based on the stage ID provided in the request.

Parameters:	build_pipeline_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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_connection(connection_id, **kwargs)¶

Deletes a connection resource by identifier.

Parameters:	connection_id (str) – (required) Unique connection 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_connection 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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.

delete_ref(repository_id, ref_name, **kwargs)¶

Deletes a Repository’s Ref by its name. Returns an error if the name is ambiguous. Can be disambiguated by using full names like “heads/<name>” or “tags/<name>”. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ‘/’. This will be replaced by “/repositories/{repositoryId}/actions/deleteGitRef”.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref_name (str) – (required) A filter to return only resources that match the given reference name. 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_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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_repository(repository_id, **kwargs)¶

Deletes a repository resource by identifier.

Parameters:	repository_id (str) – (required) Unique repository 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_trigger(trigger_id, **kwargs)¶

Deletes a trigger resource by identifier.

Parameters:	trigger_id (str) – (required) Unique trigger 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

get_build_pipeline(build_pipeline_id, **kwargs)¶

Retrieves a build pipeline by identifier.

Parameters:	build_pipeline_id (str) – (required) Unique build 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipeline`
Return type:	`Response`
Example:

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

get_build_pipeline_stage(build_pipeline_stage_id, **kwargs)¶

Retrieves a stage based on the stage ID provided in the request.

Parameters:	build_pipeline_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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipelineStage`
Return type:	`Response`
Example:

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

get_build_run(build_run_id, **kwargs)¶

Returns the details of a build run for a given build run ID.

Parameters:	build_run_id (str) – (required) Unique build run 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildRun`
Return type:	`Response`
Example:

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

get_commit(repository_id, commit_id, **kwargs)¶

Retrieves a repository’s commit by commit ID.

Parameters:	repository_id (str) – (required) Unique repository identifier. commit_id (str) – (required) A filter to return only resources that match the given commit ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryCommit`
Return type:	`Response`
Example:

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

get_commit_diff(repository_id, target_version, **kwargs)¶

Compares two revisions for their differences. Supports comparison between two references or commits.

Parameters:	repository_id (str) – (required) Unique repository identifier. target_version (str) – (required) The commit or reference name that represents the newer changes against the base version. base_version (str) – (optional) The commit or reference name to compare changes against. If base version is not provided, the difference goes against an empty tree. is_comparison_from_merge_base (bool) – (optional) Boolean value to indicate whether to use merge base or most recent revision. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DiffResponse`
Return type:	`Response`
Example:

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

get_connection(connection_id, **kwargs)¶

Retrieves a connection by identifier.

Parameters:	connection_id (str) – (required) Unique connection 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use get_connection 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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_file_diff(repository_id, file_path, base_version, target_version, **kwargs)¶

Gets the line-by-line difference between file on different commits. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has ‘/’. This will be replaced by “/repositories/{repositoryId}/file/diffs”

Parameters:	repository_id (str) – (required) Unique repository identifier. file_path (str) – (required) Path to a file within a repository. base_version (str) – (required) The branch to compare changes against. target_version (str) – (required) The branch where changes are coming from. is_comparison_from_merge_base (bool) – (optional) Boolean to indicate whether to use merge base or most recent revision. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FileDiffResponse`
Return type:	`Response`
Example:

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

get_mirror_record(repository_id, mirror_record_type, **kwargs)¶

Returns either current mirror record or last successful mirror record for a specific mirror repository.

Parameters:	repository_id (str) – (required) Unique repository identifier. mirror_record_type (str) – (required) The field of mirror record type. Only one mirror record type can be provided: current - The current mirror record. lastSuccessful - The last successful mirror record. Allowed values are: “current”, “lastSuccessful” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryMirrorRecord`
Return type:	`Response`
Example:

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

get_object(repository_id, **kwargs)¶

Retrieves blob of specific branch name/commit ID and file path.

Parameters:	repository_id (str) – (required) Unique repository identifier. file_path (str) – (optional) A filter to return only commits that affect any of the specified paths. ref_name (str) – (optional) A filter to return only resources that match the given reference name. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryObject`
Return type:	`Response`
Example:

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

get_object_content(repository_id, sha, **kwargs)¶

Retrieve contents of a specified object.

Parameters:	repository_id (str) – (required) Unique repository identifier. sha (str) – (required) The SHA of a blob or tree. file_path (str) – (optional) A filter to return only commits that affect any of the specified paths. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use get_object_content 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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_ref(repository_id, ref_name, **kwargs)¶

This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ‘/’. This will be replaced by “/repositories/{repositoryId}/refs”. Retrieves a repository’s reference by its name with preference for branches over tags if the name is ambiguous. This can be disambiguated by using full names like “heads/<name>” or “tags/<name>”.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref_name (str) – (required) A filter to return only resources that match the given reference name. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryRef`
Return type:	`Response`
Example:

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

get_repo_file_diff(repository_id, base_version, target_version, **kwargs)¶

Gets the line-by-line difference between file on different commits.

Parameters:	repository_id (str) – (required) Unique repository identifier. base_version (str) – (required) The branch to compare changes against. target_version (str) – (required) The branch where changes are coming from. file_path (str) – (optional) A filter to return only commits that affect any of the specified paths. is_comparison_from_merge_base (bool) – (optional) Boolean to indicate whether to use merge base or most recent revision. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FileDiffResponse`
Return type:	`Response`
Example:

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

get_repo_file_lines(repository_id, revision, **kwargs)¶

Retrieve lines of a specified file. Supports starting line number and limit.

Parameters:	repository_id (str) – (required) Unique repository identifier. revision (str) – (required) Retrieve file lines from specific revision. file_path (str) – (optional) A filter to return only commits that affect any of the specified paths. start_line_number (int) – (optional) Line number from where to start returning file lines. limit (int) – (optional) The maximum number of items to return. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryFileLines`
Return type:	`Response`
Example:

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

get_repository(repository_id, **kwargs)¶

Retrieves a repository by identifier.

Parameters:	repository_id (str) – (required) Unique repository 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. fields (list[str]) – (optional) Fields parameter can contain multiple flags useful in deciding the API functionality. Allowed values are: “branchCount”, “commitCount”, “sizeInBytes” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Repository`
Return type:	`Response`
Example:

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

get_repository_archive_content(repository_id, **kwargs)¶

Returns the archived repository information.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref_name (str) – (optional) A filter to return only resources that match the given reference name. format (str) – (optional) The archive format query parameter for downloading repository endpoint. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

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

get_repository_file_lines(repository_id, file_path, revision, **kwargs)¶

Retrieve lines of a specified file. Supports starting line number and limit. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has ‘/’. This will be replaced by “/repositories/{repositoryId}/file/lines”

Parameters:	repository_id (str) – (required) Unique repository identifier. file_path (str) – (required) Path to a file within a repository. revision (str) – (required) Retrieve file lines from specific revision. start_line_number (int) – (optional) Line number from where to start returning file lines. limit (int) – (optional) The maximum number of items to return. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryFileLines`
Return type:	`Response`
Example:

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

get_trigger(trigger_id, **kwargs)¶

Retrieves a trigger by identifier.

Parameters:	trigger_id (str) – (required) Unique trigger 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Trigger`
Return type:	`Response`
Example:

Click here to see an example of how to use get_trigger 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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_authors(repository_id, **kwargs)¶

Retrieve a list of all the authors.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref_name (str) – (optional) A filter to return only resources that match the given reference name. 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” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryAuthorCollection`
Return type:	`Response`
Example:

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

list_build_pipeline_stages(**kwargs)¶

Returns a list of all stages in a compartment or build pipeline.

Parameters:	id (str) – (optional) Unique identifier or OCID for listing a single resource by ID. build_pipeline_id (str) – (optional) The OCID of the parent build pipeline. compartment_id (str) – (optional) The OCID of the compartment in which to list resources. lifecycle_state (str) – (optional) A filter to return the 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipelineStageCollection`
Return type:	`Response`
Example:

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

list_build_pipelines(**kwargs)¶

Returns a list of build 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 build pipelines that matches the given lifecycle state. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipelineCollection`
Return type:	`Response`
Example:

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

list_build_runs(**kwargs)¶

Returns a list of build run summary.

Parameters:	id (str) – (optional) Unique identifier or OCID for listing a single resource by ID. build_pipeline_id (str) – (optional) Unique build pipeline identifier. project_id (str) – (optional) unique project identifier compartment_id (str) – (optional) The OCID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) A filter to return only build runs that matches the given lifecycle state. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, “DELETING” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildRunSummaryCollection`
Return type:	`Response`
Example:

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

list_commit_diffs(repository_id, base_version, target_version, **kwargs)¶

Compares two revisions and lists the differences. Supports comparison between two references or commits.

Parameters:	repository_id (str) – (required) Unique repository identifier. base_version (str) – (required) The commit or reference name to compare changes against. target_version (str) – (required) The commit or reference name where changes are coming from. is_comparison_from_merge_base (bool) – (optional) Boolean value to indicate whether to use merge base or most recent revision. 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DiffCollection`
Return type:	`Response`
Example:

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

list_commits(repository_id, **kwargs)¶

Returns a list of commits.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref_name (str) – (optional) A filter to return only resources that match the given reference name. exclude_ref_name (str) – (optional) A filter to exclude commits that match the given reference name. file_path (str) – (optional) A filter to return only commits that affect any of the specified paths. timestamp_greater_than_or_equal_to (datetime) – (optional) A filter to return commits only created after the specified timestamp value. timestamp_less_than_or_equal_to (datetime) – (optional) A filter to return commits only created before the specified timestamp value. commit_message (str) – (optional) A filter to return any commits that contains the given message. author_name (str) – (optional) A filter to return any commits that are pushed by the requested author. 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryCommitCollection`
Return type:	`Response`
Example:

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

list_connections(**kwargs)¶

Returns a list of connections.

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 connections that matches the given lifecycle state. Allowed values are: “ACTIVE”, “DELETING” display_name (str) – (optional) A filter to return only resources that match the entire display name given. connection_type (str) – (optional) A filter to return only resources that match the given connection type. Allowed values are: “GITHUB_ACCESS_TOKEN”, “GITLAB_ACCESS_TOKEN”, “GITLAB_SERVER_ACCESS_TOKEN”, “BITBUCKET_SERVER_ACCESS_TOKEN”, “BITBUCKET_CLOUD_APP_PASSWORD”, “VBS_ACCESS_TOKEN” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_connections 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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”, “NEEDS_ATTENTION” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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_mirror_records(repository_id, **kwargs)¶

Returns a list of mirror entry in history within 30 days.

Parameters:	repository_id (str) – (required) Unique repository identifier. 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” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryMirrorRecordCollection`
Return type:	`Response`
Example:

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

list_paths(repository_id, **kwargs)¶

Retrieves a list of files and directories in a repository.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref (str) – (optional) The name of branch/tag or commit hash it points to. If names conflict, order of preference is commit > branch > tag. You can disambiguate with “heads/foobar” and “tags/foobar”. If left blank repository’s default branch will be used. paths_in_subtree (bool) – (optional) Flag to determine if files must be retrived recursively. Flag is False by default. folder_path (str) – (optional) The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository. 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. display_name (str) – (optional) A filter to return only resources that match the entire display name given. 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 is ascending. If no value is specified name is default. Allowed values are: “type”, “sizeInBytes”, “name” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryPathCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_paths 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”, “NEEDS_ATTENTION” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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_refs(repository_id, **kwargs)¶

Returns a list of references.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref_type (str) – (optional) Reference type to distinguish between branch and tag. If it is not specified, all references are returned. Allowed values are: “BRANCH”, “TAG” commit_id (str) – (optional) Commit ID in a repository. 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. ref_name (str) – (optional) A filter to return only resources that match the given reference name. 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 reference name is ascending. Default order for reference type is ascending. If no value is specified reference name is default. Allowed values are: “refType”, “refName” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryRefCollection`
Return type:	`Response`
Example:

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

list_repositories(**kwargs)¶

Returns a list of repositories given a compartment ID or a project ID.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list resources. project_id (str) – (optional) unique project identifier repository_id (str) – (optional) Unique repository identifier. lifecycle_state (str) – (optional) A filter to return only resources whose lifecycle state matches the given lifecycle state. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING” 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 name is ascending. If no value is specified time created is default. Allowed values are: “timeCreated”, “name” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryCollection`
Return type:	`Response`
Example:

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

list_triggers(**kwargs)¶

Returns a list of triggers.

Parameters:	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 triggers that matches the given lifecycle state. Allowed values are: “ACTIVE”, “DELETING” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) Unique trigger identifier. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TriggerCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_triggers 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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”, “WAITING”, “NEEDS_ATTENTION” 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” operation_type_multi_value_query (list[str]) – (optional) A filter to return only resources where their Operation Types matches the parameter operation types 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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.

mirror_repository(repository_id, **kwargs)¶

Synchronize a mirrored repository to the latest version from external providers.

Parameters:	repository_id (str) – (required) Unique repository 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

put_repository_ref(repository_id, ref_name, put_repository_ref_details, **kwargs)¶

Creates a new reference or updates an existing one. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ‘/’. This will be replaced by “/repositories/{repositoryId}/actions/createOrUpdateGitRef”.

Parameters:	repository_id (str) – (required) Unique repository identifier. ref_name (str) – (required) A filter to return only resources that match the given reference name. put_repository_ref_details (oci.devops.models.PutRepositoryRefDetails) – (required) The information to create a reference with the type specified in the query. 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_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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RepositoryRef`
Return type:	`Response`
Example:

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

schedule_cascading_project_deletion(project_id, **kwargs)¶

Cascading operation that marks Project and child DevOps resources in a DELETING state for a retention period

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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_build_pipeline(build_pipeline_id, update_build_pipeline_details, **kwargs)¶

Updates the build pipeline.

Parameters:	build_pipeline_id (str) – (required) Unique build pipeline identifier. update_build_pipeline_details (oci.devops.models.UpdateBuildPipelineDetails) – (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipeline`
Return type:	`Response`
Example:

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

update_build_pipeline_stage(build_pipeline_stage_id, update_build_pipeline_stage_details, **kwargs)¶

Updates the stage based on the stage ID provided in the request.

Parameters:	build_pipeline_stage_id (str) – (required) Unique stage identifier. update_build_pipeline_stage_details (oci.devops.models.UpdateBuildPipelineStageDetails) – (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildPipelineStage`
Return type:	`Response`
Example:

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

update_build_run(build_run_id, update_build_run_details, **kwargs)¶

Updates the build run.

Parameters:	build_run_id (str) – (required) Unique build run identifier. update_build_run_details (oci.devops.models.UpdateBuildRunDetails) – (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BuildRun`
Return type:	`Response`
Example:

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

update_connection(connection_id, update_connection_details, **kwargs)¶

Updates the connection.

Parameters:	connection_id (str) – (required) Unique connection identifier. update_connection_details (oci.devops.models.UpdateConnectionDetails) – (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use update_connection 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
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.

update_repository(repository_id, update_repository_details, **kwargs)¶

Updates the repository.

Parameters:	repository_id (str) – (required) Unique repository identifier. update_repository_details (oci.devops.models.UpdateRepositoryDetails) – (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Repository`
Return type:	`Response`
Example:

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

update_trigger(trigger_id, update_trigger_details, **kwargs)¶

Updates the trigger.

Parameters:	trigger_id (str) – (required) Unique trigger identifier. update_trigger_details (oci.devops.models.UpdateTriggerDetails) – (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Trigger`
Return type:	`Response`
Example:

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

validate_connection(connection_id, **kwargs)¶

Return whether the credentials of the connection are valid.

Parameters:	connection_id (str) – (required) Unique connection 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. 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_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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

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