# Functions
As is the equivalent of the std errors.As, and allows devs to only import this package for the capability.
Convert will convert the error to a Boundary *Err (returning it as an error) and attempt to add a helpful error msg as well.
E creates a new Err with provided code and supports the options of:
* WithoutEvent - allows you to specify that an error event should not be emitted.
FromPbErrors will convert from Err protobuf.
GetOpts - iterate the inbound Options and return a struct.
Is the equivalent of the std errors.Is, but allows Devs to only import this package for the capability.
IsCheckConstraintError returns a boolean indicating whether the error is known to report a check constraint violation.
IsConflictError returns a boolean indicating whether the error is known to report a pre-conditional check violation or an aborted transaction.
IsMissingTableError returns a boolean indicating whether the error is known to report a undefined/missing table violation.
IsNotFoundError returns a boolean indicating whether the error is known to report a not found violation.
IsNotNullError returns a boolean indicating whether the error is known to report a not-null constraint violation.
IsUniqueError returns a boolean indicating whether the error is known to report a unique constraint violation.
Match the template against the error.
New creates a new Err with provided code, op and msg It supports the options of:
* WithWrap() - allows you to specify an error to wrap.
T creates a new Template for matching Errs.
ToPbErrors will convert to an Err protobuf.
WithCode provides an option to provide a code when creating a new error.
WithMsg provides an option to provide a message when creating a new error.
WithOp provides an option to provide the operation that's raising/propagating the error.
WithoutEvent provides an option to suppress the event when wrapping or creating a new error.
WithErrCode provides an option to provide an error to wrap when creating a new error.
Wrap creates a new Err from the provided err and op, preserving the code from the originating error.
# Constants
AccountAlreadyAssociated represents an attempt to associate an account failed since it was already associated.
AuthAttemptExpired represents an expired authentication attempt.
AuthMethodInactive represents an error that means the auth method is not active.
CheckConstraint represents a check constraint error.
ChecksumMismatch represents an error when a checksum is mismatched.
Closed represents an error when an operation cannot be completed because the thing being operated on is closed.
ColumnNotFound represent that a column was not found in the underlying db.
No description provided by the author
Conflict represents the operation failed due to failed pre-condition or was aborted.
CycleFound represents an error when a cycle is found between a parent and child worker.
Decode represents an error occurred during the underlying decoding/unmarshaling process.
Decrypt represents an error occurred during the underlying decryption process.
EmptyFieldMask represents an empty field mask for an operation.
Encode represents an error occurred during the underlying encoding/marshaling process.
No description provided by the author
Encrypt represents an error occurred during the underlying encryption process.
No description provided by the author
Exception represent that an underlying db exception was raised.
No description provided by the author
ExternalPlugin represent an error that occurred on a plugin external to Boundary.
Forbidden represents the operation is forbidden.
GenCert represents an error occurred during the underlying certificate generation process.
GenKey represents an error occurred during the underlying key generation process.
GracefullyAborted means we intended to abort a transaction but the enclosing function should not treat it as an error; we aborted for reasons related to the state of the DDL and/or inputs (such as we're already in the right state and don't want to end up writing oplogs).
ImmutableColumn is used when an operation attempted to mutate an immutable column.
No description provided by the author
InternalError represents the system encountered an unexpected condition.
InvalidAddress represents an invalid host address for an operation.
InvalidConfiguration represents an error with the configuration file.
InvalidDynamicCredential represents that a dynamic credential for a session was in an invalid state.
InvalidFieldMask represents an invalid field mask for an operation.
InvalidJobRunState represents that a JobRun was in an invalid state.
InvalidListToken represents an error where the provided list token is invalid.
InvalidParameter represents an invalid parameter for an operation.
InvalidPublicId represents an invalid public Id for an operation.
InvalidSessionState represents that the session was in an invalid state.
InvalidTextRepresentation represents a value does not have the correct text representation.
InvalidTimeStamp represents an invalid time stamp for an operation.
Io represents that an io error occurred in an underlying call (i.e binary.Write).
JobAlreadyRunning represents that a Job is already running when an attempt to run again was made.
KeyNotFound represents that a key/version was not found in the KMS.
KmsWorkerUnsupportedOperation represents an error when a KMS worker is not supported for an operation.
MaxRetries represent that a db Tx hit max retires allowed.
MigrationIntegrity represents an error with the generated migration related code.
MigrationLock represents an error related to locking of the DB.
MissingTable represents an undefined table error.
MultipleRecords represents that multiple records/rows were found matching the criteria.
NoPathFound represents an error when no path is found to a worker.
NotFound represents an operation which is unable to find the requested item.
NotNull represents a value must not be null error.
NotSpecificIntegrity represents an integrity error that has no specific domain error code.
NotUnique represents a value must be unique error.
OidcProviderCallbackError represents an error that is passed by the OIDC provider to the callback endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
PasswordInvalidConfiguration results from attempting to perform an operation that sets a valid password configuration with invalid settings.
PasswordsEqual is returned from ChangePassword when the old and new passwords are equal.
PasswordTooShort results from attempting to set a password which is to short.
PasswordUnsupportedConfiguration results from attempting to perform an operation that sets a password configuration to an unsupported type.
Paused represents an error when an operation cannot be completed because the thing being operated on is paused.
QueueIsFull results in attempting to add an item to a queue which is full.
RecordNotFound represents that a record/row was not found matching the criteria.
RetryLimitExceeded represents an error when a retry limit is exceeded.
No description provided by the author
SessionNotFound represents that the session was not found.
Sign represents an error occurred during the underlying signing process.
No description provided by the author
StorageContainerClosed represents an error when a container has been closed and a I/O operation is attempted on it.
StorageContainerReadOnly represents an error when a container is readonly and a write operation is attempted on it.
StorageContainerWriteOnly represents an error when a container is write only and a read operation is attempted on it.
StorageFileAlreadyExists represents an error when a file already exists during an attempt to create it.
StorageFileClose represents an error when a file has been closed and a read/write operation is attempted on it.
StorageFileReadOnly represents an error when a file is readonly and a write operation is attempted on it.
StorageFileWriteOnly represents an error when a file is write only and a read operation is attempted on it.
SubtypeAlreadyRegistered represents that a value has already been registered in the subtype registry system.
TicketAlreadyRedeemed represents that the ticket version has already been redeemed.
TicketNotFound represents that the ticket was not found.
TokenMismatch represents that there was a token mismatch.
TooShort represents an error that means the provided input is not meeting minimum length requirements.
No description provided by the author
Unauthorized represents the operation is unauthorized.
Unavailable represents that an external system is unavailable.
UnexpectedRowsAffected indicates that an action expected to operate on a specific number of records returned a different count, e.g.
Unknown will be equal to a zero value for Codes.
VaultCredentialRequest represents an error returned from Vault when retrieving a credential.
VaultEmptySecret represents a empty secret was returned from Vault without error.
VaultInvalidCredentialMapping represents an error returned when a Vault secret failed to be mapped to a specific credential type.
VaultInvalidMappingOverride represents an error returned when a credential mapping is unknown or does not match a credential type.
No description provided by the author
VaultTokenMissingCapabilities represents an error for a Vault token that is missing capabilities.
VaultTokenNotOrphan represents an error for a Vault token that is not an orphan token.
VaultTokenNotPeriodic represents an error for a Vault token that is not a periodic token.
VaultTokenNotRenewable represents an error for a Vault token that is not renewable.
Verify represents an error occurred during the underlying verification process.
VersionMismatch represents the update version and the db version for an entry do not match.
WorkerConnNotFound represents an error when a connection to a worker is not found.
WorkerNotFound represents an error when a worker is not found in the graph of downstream workers.
WorkerNotFoundForRequest represents an error when no appropriate worker is found which meets the conditions required to handle a request.