CompleteBranchRequest Properties
An object defining properties for the CompleteBranchRequest class.
SecretKey
Gets the encrypted secret key for the object being versioned.
Type: string
This property contains the encrypted security key for the object that will receive the new version. 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.
BranchSecretKey
Gets the encrypted secret key for the branch being completed.
Type: string
This property contains the encrypted security key for the branch that will be converted into a version. 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.
DecryptedBranchSecret
Gets the decrypted secret information for the branch being completed.
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 completion process.
SetAsDefaultVersion
Gets whether the new version should be set as the default version of the object.
Type: bool
This property determines if the version created from the branch should be marked as the default version of the object. It is read-only and initialized through the constructor. When set to true, the new version will become the primary version displayed and used for the object.
DecryptedObjectSecret
Gets the decrypted secret information for the object being versioned.
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 completion process.
MinorVersionValue
Gets the minor version number for the new version being created from the branch.
Type: long
This property specifies the minor version number that will be assigned to the new version when the branch is completed. It is read-only and initialized through the constructor, forming part of the version's semantic versioning identifier (Major.Minor).
CreatedBy
Gets the ID of the user completing the branch.
This property contains the optional identifier of the user who is completing the branch and creating the new version. It is read-only and initialized through the constructor, serving as part of the audit trail to track who performed the branch completion. When not specified, the system will use the current user's context.
MajorVersionValue
Gets the major version number for the new version being created from the branch.
Type: long
This property specifies the major version number that will be assigned to the new version when the branch is completed. It is read-only and initialized through the constructor, forming part of the version's semantic versioning identifier (Major.Minor).
VersionDate
Gets the optional timestamp to be assigned to the new version.
Type: DateTimeOffset?
This property specifies the optional date and time that will be assigned to the new version when the branch is completed. It is read-only and initialized through the constructor. If not specified, the system will use the current timestamp when creating the version.