Skip to main content

CancelBranchRequest Properties

An object defining properties for the CancelBranchRequest class.

DecryptedObjectSecret​

Gets the decrypted secret information for the object containing the branch.

Type: DMObjectSecret

This property contains the decrypted version of the SecretKey, automatically populated using the DecryptData attribute. It provides secure access to the object's decrypted security information and has a private setter to ensure controlled access to the sensitive data during the branch cancellation process.

SecretKey​

Gets the encrypted secret key for the object containing the branch.

Type: string

This property contains the encrypted security key for the object that contains the branch to be cancelled. It is read-only and works in conjunction with the DecryptedObjectSecret property to verify access to the object. The key is initialized through the constructor and remains unchanged throughout the request lifecycle.

DecryptedBranchSecret​

Gets the decrypted secret information for the branch being cancelled.

Type: DMObjectVersionSecret

This property contains the decrypted version of the BranchSecretKey, automatically populated using the DecryptData attribute. It provides secure access to the branch's decrypted security information and has a private setter to ensure controlled access to the sensitive data during the branch cancellation process.

BranchSecretKey​

Gets the encrypted secret key for the branch being cancelled.

Type: string

This property contains the encrypted security key for the branch that will be cancelled. It is read-only and works in conjunction with the DecryptedBranchSecret property to verify access to the branch. The key is initialized through the constructor and remains unchanged throughout the request lifecycle.