Class CancelPipelineRunRequest

CancelPipelineRunRequest

public class CancelPipelineRunRequest : IOciRequest

Click here to see an example of how to use CancelPipelineRun request.

[HttpConverter(TargetEnum.Header, "if-match")]
public string IfMatch { get; set; }

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

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Type	Description
string	Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

[HttpConverter(TargetEnum.Header, "opc-retry-token")]
public string OpcRetryToken { get; set; }

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

[Required(ErrorMessage = "PipelineRunId is required.")]
[HttpConverter(TargetEnum.Path, "pipelineRunId")]
public string PipelineRunId { get; set; }

Type	Description
string	The OCID of the pipeline run.

Required

[HttpConverter(TargetEnum.Query, "terminateGracefully")]
public bool? TerminateGracefully { get; set; }

Type	Description
bool?	A boolean value to specify whether to terminate pipeline run gracefully.