AwsScheduleExpressionValidator.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>AwsScheduleExpressionValidator</name> </assembly> <members> <member name="T:AwsScheduleExpressionValidator.AwsScheduleValidationError"> <summary> Defines the error types that can occur when validating AWS schedule expressions. </summary> <remarks>This enumeration is used to represent specific validation errors encountered during the evaluation of AWS schedule configurations. Each value corresponds to a distinct error condition that can be checked programmatically to determine the nature of a validation failure.</remarks> </member> <member name="F:AwsScheduleExpressionValidator.AwsScheduleValidationError.None"> <summary> Indicates that no validation errors were encountered, and the AWS schedule expression is considered valid. </summary> </member> <member name="F:AwsScheduleExpressionValidator.AwsScheduleValidationError.InvalidFormat"> <summary> Represents an error that occurs when the format of the AWS schedule expression is invalid. This error is typically encountered when the expression does not conform to the expected syntax or structure. </summary> </member> <member name="F:AwsScheduleExpressionValidator.AwsScheduleValidationError.InvalidIntervalConfiguration"> <summary> Represents an error that occurs when an interval configuration is invalid. </summary> <remarks>This exception is typically thrown when the specified interval does not meet the required constraints, such as being negative or exceeding maximum limits. Ensure that the interval values are validated before configuration to prevent this exception.</remarks> </member> <member name="F:AwsScheduleExpressionValidator.AwsScheduleValidationError.IntervalConstraintViolation"> <summary> Represents a violation of an interval constraint, indicating that a specified condition related to time intervals has not been met. </summary> <remarks>This class is typically used in scenarios where constraints on time intervals are enforced, such as scheduling or timing operations. It may contain properties that provide details about the specific violation, including the expected and actual interval values.</remarks> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult"> <summary> Represents the result of validating an AWS schedule expression, indicating whether the expression is valid and providing error details if validation fails. </summary> <remarks>Use the static <see cref="P:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult.Success"/> property to represent a successful validation result with no errors.</remarks> <param name="IsValid">Indicates whether the AWS schedule expression is valid. A value of <see langword="true"/> signifies a valid expression; otherwise, <see langword="false"/>.</param> <param name="Error">Specifies the type of validation error encountered, if any. This value identifies the nature of the validation failure.</param> <param name="Message">Provides a descriptive message related to the validation result. The message may include guidance or details about the validation outcome.</param> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult.#ctor(System.Boolean,AwsScheduleExpressionValidator.AwsScheduleValidationError,System.String)"> <summary> Represents the result of validating an AWS schedule expression, indicating whether the expression is valid and providing error details if validation fails. </summary> <remarks>Use the static <see cref="P:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult.Success"/> property to represent a successful validation result with no errors.</remarks> <param name="IsValid">Indicates whether the AWS schedule expression is valid. A value of <see langword="true"/> signifies a valid expression; otherwise, <see langword="false"/>.</param> <param name="Error">Specifies the type of validation error encountered, if any. This value identifies the nature of the validation failure.</param> <param name="Message">Provides a descriptive message related to the validation result. The message may include guidance or details about the validation outcome.</param> </member> <member name="P:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult.IsValid"> <summary>Indicates whether the AWS schedule expression is valid. A value of <see langword="true"/> signifies a valid expression; otherwise, <see langword="false"/>.</summary> </member> <member name="P:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult.Error"> <summary>Specifies the type of validation error encountered, if any. This value identifies the nature of the validation failure.</summary> </member> <member name="P:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult.Message"> <summary>Provides a descriptive message related to the validation result. The message may include guidance or details about the validation outcome.</summary> </member> <member name="P:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationResult.Success"> <summary> Gets a predefined validation result indicating that the AWS schedule expression is valid and contains no errors. </summary> <remarks>Use this property to represent a successful validation outcome when no issues are detected in the schedule expression. This instance can be used as a standard result for valid expressions.</remarks> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleValidationException"> <summary> Represents an exception that is thrown when an AWS schedule expression fails validation. </summary> <remarks>This exception is typically thrown when a schedule expression provided to AWS services does not meet the required validation criteria. Use this exception to identify and handle invalid schedule expressions in your application logic.</remarks> <param name="message">The error message that describes the reason for the validation failure.</param> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleValidationException.#ctor(System.String)"> <summary> Represents an exception that is thrown when an AWS schedule expression fails validation. </summary> <remarks>This exception is typically thrown when a schedule expression provided to AWS services does not meet the required validation criteria. Use this exception to identify and handle invalid schedule expressions in your application logic.</remarks> <param name="message">The error message that describes the reason for the validation failure.</param> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleExpressionFormatException"> <summary> Represents an error that occurs when the format of an AWS schedule expression is invalid. </summary> <remarks>This exception is thrown when the provided schedule expression does not conform to the expected format for AWS scheduling.</remarks> <param name="message">The error message that describes the reason for the exception.</param> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionFormatException.#ctor(System.String)"> <summary> Represents an error that occurs when the format of an AWS schedule expression is invalid. </summary> <remarks>This exception is thrown when the provided schedule expression does not conform to the expected format for AWS scheduling.</remarks> <param name="message">The error message that describes the reason for the exception.</param> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleIntervalConfigurationException"> <summary> Represents an exception that is thrown when a configuration error occurs related to the AWS schedule interval. </summary> <param name="message">The error message that describes the reason for the exception.</param> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleIntervalConfigurationException.#ctor(System.String)"> <summary> Represents an exception that is thrown when a configuration error occurs related to the AWS schedule interval. </summary> <param name="message">The error message that describes the reason for the exception.</param> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleIntervalViolationException"> <summary> Represents an exception that is thrown when a schedule interval violation occurs in AWS schedule validation. </summary> <remarks>This exception is a specific type of AwsScheduleValidationException, indicating that the provided schedule does not adhere to the expected interval constraints.</remarks> <param name="message">The error message that describes the reason for the exception.</param> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleIntervalViolationException.#ctor(System.String)"> <summary> Represents an exception that is thrown when a schedule interval violation occurs in AWS schedule validation. </summary> <remarks>This exception is a specific type of AwsScheduleValidationException, indicating that the provided schedule does not adhere to the expected interval constraints.</remarks> <param name="message">The error message that describes the reason for the exception.</param> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation"> <summary> Provides configuration and validation for AWS schedule expressions, including interval constraints, occurrence count, and start time. Enables fluent setup of validation parameters and supports exception handling for validation failures. </summary> <remarks>Use this class to configure validation rules for AWS schedule expressions, such as minimum and maximum intervals between scheduled events, the number of occurrences to validate, and the start time for scheduling. The class offers methods for fluent configuration and allows callers to choose whether validation failures should throw exceptions or return detailed error results. Validation methods ensure that only schedule expressions meeting the specified constraints are considered valid. For a simple validity check, use the IsValid method; for detailed validation results, use Evaluate.</remarks> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.WithMinInterval(System.TimeSpan)"> <summary> Sets the minimum interval that must be observed between scheduled events for validation purposes. </summary> <param name="minInterval">The minimum interval, as a <see cref="T:System.TimeSpan"/>, that scheduled expressions must adhere to. Must be a positive duration.</param> <returns>The current <see cref="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation"/> instance, enabling method chaining.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.WithMaxInterval(System.TimeSpan)"> <summary> Sets the maximum interval allowed for schedule expression validation. </summary> <remarks>Use this method to enforce an upper limit on the interval when validating schedule expressions. This helps ensure that only intervals within the specified range are considered valid.</remarks> <param name="maxInterval">The maximum time span permitted for the interval. Must be a positive value.</param> <returns>The current instance of the AwsScheduleExpressionValidation for method chaining.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.ThrowExceptionOnFailure"> <summary> Enables exception throwing when validation fails, allowing callers to handle errors through exception handling. </summary> <returns>The current instance of the AwsScheduleExpressionValidation class, enabling method chaining.</returns> <exception cref="T:AwsScheduleExpressionValidator.AwsScheduleExpressionFormatException">Thrown when the schedule expression format is invalid.</exception> <exception cref="T:AwsScheduleExpressionValidator.AwsScheduleIntervalConfigurationException">Thrown when the interval configuration is invalid (e.g., negative intervals, min greater than max).</exception> <exception cref="T:AwsScheduleExpressionValidator.AwsScheduleIntervalViolationException">Thrown when the schedule expression violates specified interval constraints.</exception> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.WithOccurrenceCount(System.Int32)"> <summary> Sets the occurrence count used for schedule expression validation and returns the current instance for method chaining. </summary> <param name="count">The number of occurrences to use for validation. Must be a non-negative integer.</param> <returns>The current instance of <see cref="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation"/> with the updated occurrence count.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.WithOccurrenceStart(System.DateTimeOffset)"> <summary> Sets the start date and time for the occurrence schedule. </summary> <remarks>This method allows for configuring the start time of the occurrence, which is essential for scheduling tasks accurately.</remarks> <param name="start">The date and time when the occurrence should start. This value cannot be in the past.</param> <returns>Returns the current instance of the AwsScheduleExpressionValidation for method chaining.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.IsValid"> <summary> Validates the AWS schedule expression and its associated interval constraints. </summary> <remarks>This method checks the format of the schedule expression and ensures that any specified minimum and maximum intervals are valid and logically consistent. To return a more declarative response, use the <see cref="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.Evaluate"/> method instead.</remarks> <returns> <see langword="true"/> if valid, else <see langword="false"/> </returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.Evaluate"> <summary> Validates the AWS schedule expression and its associated interval constraints. </summary> <remarks> This method checks the format of the schedule expression and ensures that any specified minimum and maximum intervals are valid and logically consistent. It returns a success result if all validations pass, or a failure result with detailed error information if any validation fails. To return a simple boolean result, use the <see cref="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.IsValid"/> method instead. </remarks> <returns>An instance of AwsScheduleExpressionValidationResult indicating whether the schedule expression and interval configuration are valid. Returns a failure result with an appropriate error if validation does not succeed.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidation.GetNextScheduleExpressionOccurrences"> <summary> Gets the next scheduled occurrences based on the current schedule expression, occurrence count, and start time. </summary> <remarks>The method validates the schedule expression format and occurrence count before retrieving occurrences. If validation fails, the method returns an empty list and handles the failure internally.</remarks> <returns>A read-only list of <see cref="T:System.DateTimeOffset"/> values representing the next scheduled occurrences. The list is empty if the schedule expression format is invalid or the occurrence count is less than or equal to zero.</returns> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationExtensions"> <summary> Provides extension methods for validating AWS schedule expressions. </summary> <remarks>This class contains methods that enable a fluent interface for validating AWS schedule expressions.</remarks> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidationExtensions.ValidateAwsScheduleExpression(System.String)"> <summary> Validates the specified AWS schedule expression and returns the result of the validation. </summary> <remarks>This method is an extension method for the string class, enabling a fluent interface for validating AWS schedule expressions.</remarks> <param name="expression">The AWS schedule expression to validate. This string must conform to the AWS schedule expression format.</param> <returns>An instance of AwsScheduleExpressionValidation that indicates whether the expression is valid and provides details about any validation errors.</returns> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator"> <summary> Validator for AWS EventBridge Scheduler schedule expressions (CRON and rate). Supports format validation and minimum timespan checks between executions. </summary> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.ValidateFormat(System.String)"> <summary> Validates if the schedule expression is a valid AWS EventBridge format (CRON, rate, or at). Should be one of the following formats: <list type="bullet"> <item><description>cron({cron expression})</description></item> <item><description>{cron expression}</description></item> <item><description>rate({rate expression})</description></item> <item><description>at({at expression})</description></item> </list> </summary> <param name="expression">The schedule expression to validate.</param> <returns>True if valid, false otherwise.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.ValidateWithIntervals(System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})"> <summary> Validates schedule expression format and ensures timespan constraints between executions. For CRON, checks intervals between occurrences against min/max. For rate, checks rate interval against min/max. For at, validates only if no min/max constraints (one-time has no intervals). </summary> <param name="expression">The schedule expression.</param> <param name="minInterval">Minimum allowed timespan between executions (optional).</param> <param name="maxInterval">Maximum allowed timespan between executions (optional).</param> <returns>True if valid format and respects constraints, false otherwise.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.GetNextOccurrences(System.String,System.Int32,System.Nullable{System.DateTimeOffset})"> <summary> Gets the next expected execution times for a schedule expression. </summary> <param name="expression">The schedule expression.</param> <param name="count">Maximum number of occurrences to return.</param> <param name="start">Optional start time to calculate from.</param> <returns>List of upcoming execution times (UTC).</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.ValidateCronFormat(System.String)"> <summary> Validates a CRON expression. </summary> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.ValidateRateFormat(System.String)"> <summary> Validates a rate expression. </summary> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.ValidateAtFormat(System.String)"> <summary> Validates an at expression. </summary> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.TryCreateQuartzExpression(System.String,Quartz.CronExpression@)"> <summary> Attempts to parse a string representation of a cron schedule and create a corresponding Quartz CronExpression object. </summary> <param name="expression">The string containing the cron expression to be parsed. Must be in a valid cron format, either prefixed with 'cron(' or as a standard cron expression.</param> <param name="expr">When the method returns, contains the created CronExpression object if parsing succeeds; otherwise, contains null.</param> <returns>true if the cron expression was successfully parsed and a CronExpression object was created; otherwise, false.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator.GetRateInterval(System.String)"> <summary> Gets the interval for a rate expression. </summary> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator`1"> <summary> FluentValidation validator for AWS EventBridge schedule expressions. </summary> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator`1.#ctor(System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})"> <summary> FluentValidation validator for AWS EventBridge schedule expressions. </summary> </member> <member name="P:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator`1.Name"> <summary> AwsScheduleExpressionValidator </summary> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator`1.IsValid(FluentValidation.ValidationContext{`0},System.String)"> <summary> Validates the specified cron expression against the defined minimum and maximum interval constraints. </summary> <remarks>This method uses the AwsScheduleExpressionValidator to ensure that the cron expression adheres to the configured interval limits.</remarks> <param name="context">The validation context that provides additional information about the validation operation.</param> <param name="value">The cron expression to validate. Must be formatted according to AWS standards.</param> <returns>true if the cron expression is valid according to the specified interval constraints; otherwise, false.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator`1.GetDefaultMessageTemplate(System.String)"> <summary> Generates a default error message template that describes the error condition based on defined interval constraints. </summary> <remarks>The returned message template varies depending on whether minimum or maximum interval constraints are defined. If both are present, the message includes both constraints; if only one is defined, the message reflects that specific constraint; if neither is defined, a generic error message is returned.</remarks> <param name="errorCode">The error code that identifies the specific error condition being reported.</param> <returns>A string containing the default message template for the error condition, reflecting the presence of minimum and/or maximum interval constraints.</returns> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions"> <summary> Extension methods for FluentValidation. </summary> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.MustBeValidAwsSchedule``1(FluentValidation.IRuleBuilder{``0,System.String})"> <inheritdoc cref="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.<G>$E2C5CDFC69AA32776B65B66836CA9D74`1.MustBeValidAwsSchedule"/> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.MustBeValidAwsSchedule``1(FluentValidation.IRuleBuilder{``0,System.String},System.TimeSpan)"> <inheritdoc cref="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.<G>$E2C5CDFC69AA32776B65B66836CA9D74`1.MustBeValidAwsSchedule(System.TimeSpan)"/> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.MustBeValidAwsSchedule``1(FluentValidation.IRuleBuilder{``0,System.String},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})"> <inheritdoc cref="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.<G>$E2C5CDFC69AA32776B65B66836CA9D74`1.MustBeValidAwsSchedule(System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})"/> </member> <member name="T:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.<G>$E2C5CDFC69AA32776B65B66836CA9D74`1.<M>$DFC9A0AC3EBCBA561726E8279759E563"> <summary> Adds AWS schedule expression validation to a FluentValidation rule builder. </summary> <typeparam name="T"></typeparam> <param name="ruleBuilder"></param> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.<G>$E2C5CDFC69AA32776B65B66836CA9D74`1.MustBeValidAwsSchedule"> <summary> Adds a validator to ensure that the provided AWS schedule expression conforms to AWS scheduling standards. </summary> <remarks>This method uses the <see cref="T:AwsScheduleExpressionValidator.AwsScheduleExpressionValidator`1"/> to validate the format and correctness of AWS schedule expressions. Use this method when you need to enforce AWS schedule expression validity within a FluentValidation rule set.</remarks> <returns>An instance of <see cref="T:FluentValidation.IRuleBuilderOptions`2"/> that enables further rule configuration.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.<G>$E2C5CDFC69AA32776B65B66836CA9D74`1.MustBeValidAwsSchedule(System.TimeSpan)"> <summary> Adds a validator to ensure that the provided schedule expression conforms to AWS scheduling rules and meets the specified minimum interval between executions. </summary> <remarks>Use this method to enforce AWS scheduling constraints when validating schedule expressions. The validator checks both the syntactic validity and the minimum interval requirement, helping prevent misconfiguration of scheduled tasks.</remarks> <param name="minInterval">The minimum allowed time interval between scheduled executions. Must be a positive TimeSpan value.</param> <returns>An IRuleBuilderOptions instance that enables further configuration of validation rules for the schedule expression.</returns> </member> <member name="M:AwsScheduleExpressionValidator.AwsScheduleValidationExtensions.<G>$E2C5CDFC69AA32776B65B66836CA9D74`1.MustBeValidAwsSchedule(System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})"> <summary> Adds a validator that ensures the provided schedule expression conforms to AWS scheduling requirements, optionally enforcing minimum and maximum interval constraints between scheduled events. </summary> <remarks>Use this method to validate AWS schedule expressions within a FluentValidation rule, ensuring they meet specified interval requirements. The validator checks that the schedule expression is valid according to AWS rules and that the intervals between scheduled events comply with the provided constraints.</remarks> <param name="minInterval">The minimum allowed interval between scheduled events. Specify <see langword="null"/> to indicate no minimum constraint. Must be a positive <see cref="T:System.TimeSpan"/> if provided.</param> <param name="maxInterval">The maximum allowed interval between scheduled events. Specify <see langword="null"/> to indicate no maximum constraint. Must be a positive <see cref="T:System.TimeSpan"/> if provided.</param> <returns>An <see cref="T:FluentValidation.IRuleBuilderOptions`2"/> instance that enables further configuration of validation rules.</returns> </member> </members> </doc> |