Class PausePipelineRequest

Inheritance
object
PausePipelineRequest
Implements
Inherited Members
Namespace: Oci.GoldengateService.Requests
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class PausePipelineRequest : IOciRequest
Examples

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

Properties

IfMatch

Declaration
[HttpConverter(TargetEnum.Header, "if-match")]
public string IfMatch { get; set; }
Property Value
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.

IsLockOverride

Declaration
[HttpConverter(TargetEnum.Query, "isLockOverride")]
public bool? IsLockOverride { get; set; }
Property Value
Type Description
bool?

Whether to override locks (if any exist).

OpcRequestId

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

The client request ID for tracing.

OpcRetryToken

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

A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

PausePipelineDetails

Declaration
[Required(ErrorMessage = "PausePipelineDetails is required.")]
[HttpConverter(TargetEnum.Body)]
public PausePipelineDetails PausePipelineDetails { get; set; }
Property Value
Type Description
PausePipelineDetails

Details to pause the pipeline.
Remarks

Required

PipelineId

Declaration
[Required(ErrorMessage = "PipelineId is required.")]
[HttpConverter(TargetEnum.Path, "pipelineId")]
public string PipelineId { get; set; }
Property Value
Type Description
string

The OCID of the pipeline created.
Remarks

Required

Implements