Constructor Detail

Method Detail

• error

   final Optional<String> error()

  An error message if the draft version failed compilation. Populated when state is ERROR, null otherwise.

• parameters

   final AuthRule.DraftVersion.Parameters parameters()

  Parameters for the Auth Rule

• state

   final AuthRule.DraftVersion.State state()

  The state of the draft version. Most rules are created synchronously and the state is immediately SHADOWING. Rules backed by TypeScript code are compiled asynchronously — the state starts as PENDING and transitions to SHADOWING on success or ERROR on failure.

  • PENDING: Compilation of the rule is in progress (TypeScript rules only).

  • SHADOWING: The draft version is ready and evaluating in shadow mode alongside the current active version. It can be promoted to the active version.

  • ERROR: Compilation of the rule failed. Check the error field for details.

• version

   final Long version()

  The version of the rule, this is incremented whenever the rule's parameters change.

• _error

   final JsonField<String> _error()

  Returns the raw JSON value of error.

  Unlike error, this method doesn't throw if the JSON field has an unexpected type.

• _parameters

   final JsonField<AuthRule.DraftVersion.Parameters> _parameters()

  Returns the raw JSON value of parameters.

  Unlike parameters, this method doesn't throw if the JSON field has an unexpected type.

• _state

   final JsonField<AuthRule.DraftVersion.State> _state()

  Returns the raw JSON value of state.

  Unlike state, this method doesn't throw if the JSON field has an unexpected type.

• _version

   final JsonField<Long> _version()

  Returns the raw JSON value of version.

  Unlike version, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final AuthRule.DraftVersion.Builder toBuilder()

• validate

   final AuthRule.DraftVersion validate()

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static AuthRule.DraftVersion.Builder builder()

  Returns a mutable builder for constructing an instance of DraftVersion.

  The following fields are required:

  .error()
  .parameters()
  .state()
  .version()