Module io.helidon.integrations.vault.secrets.database
Package io.helidon.integrations.vault.secrets.database

Class DbCreateRole.Request

java.lang.Object
io.helidon.integrations.common.rest.ApiJsonBuilder<T>
io.helidon.integrations.common.rest.ApiJsonRequest<T>
io.helidon.integrations.vault.VaultRequest<DbCreateRole.Request>
io.helidon.integrations.vault.secrets.database.DbCreateRole.Request
All Implemented Interfaces:
ApiRequest<DbCreateRole.Request>
Enclosing class:
DbCreateRole
public static final class DbCreateRole.Request extends VaultRequest<DbCreateRole.Request>
Request object. Can be configured with additional headers, query parameters etc.

  • Method Details

    • builder

      public static DbCreateRole.Request builder()
      Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is ApiJsonBuilder.toJson(jakarta.json.JsonBuilderFactory) used by the RestApi.
      Returns:
      new request builder

    • defaultTtl

      public DbCreateRole.Request defaultTtl(Duration defaultTtl)
      Specifies the TTL for the leases associated with this role. Defaults to system/engine default TTL time.
      Parameters:
      defaultTtl - default time to live
      Returns:
      updated request

    • maxTtl

      public DbCreateRole.Request maxTtl(Duration maxTtl)
      Specifies the maximum TTL for the leases associated with this role. Defaults to system/mount default TTL time; this value is allowed to be less than the mount max TTL (or, if not set, the system max TTL), but it is not allowed to be longer.
      Parameters:
      maxTtl - maximal time to live
      Returns:
      updated request

    • addCreationStatement

      public DbCreateRole.Request addCreationStatement(String statement)
      Specifies the database statements executed to create and configure a user. See the plugin's API page for more information on support and formatting for this parameter.
      Parameters:
      statement - statement
      Returns:
      updated request

    • addRevocationStatement

      public DbCreateRole.Request addRevocationStatement(String statement)
      Specifies the database statements to be executed to revoke a user. See the plugin's API page for more information on support and formatting for this parameter.
      Parameters:
      statement - statement
      Returns:
      updated request

    • addRollbackStatement

      public DbCreateRole.Request addRollbackStatement(String statement)
      Specifies the database statements to be executed to rollback a create operation in the event of an error. Not every plugin type will support this functionality. See the plugin's API page for more information on support and formatting for this parameter.
      Parameters:
      statement - statement
      Returns:
      updated request

    • addRenewStatement

      public DbCreateRole.Request addRenewStatement(String statement)
      Specifies the database statements to be executed to renew a user. Not every plugin type will support this functionality. See the plugin's API page for more information on support and formatting for this parameter.
      Parameters:
      statement - statement
      Returns:
      updated request

    • dbName

      public DbCreateRole.Request dbName(String dbName)
      The name of the database.
      Parameters:
      dbName - db name
      Returns:
      updated request

    • name

      public DbCreateRole.Request name(String name)
      Name of the credentials.
      Parameters:
      name - the name
      Returns:
      updated request