Package ai.vectros.types

Class RoleRequest.Builder

java.lang.Object
ai.vectros.types.RoleRequest.Builder
All Implemented Interfaces:
RoleRequest._FinalStage, RoleRequest.NameStage, RoleRequest.RoleIdStage
Enclosing class:
RoleRequest
public static final class RoleRequest.Builder extends Object implements RoleRequest.RoleIdStage, RoleRequest.NameStage, RoleRequest._FinalStage

  • Method Details

    • from

      public RoleRequest.Builder from(RoleRequest other)
      Specified by:
      from in interface RoleRequest.RoleIdStage

    • roleId

      public RoleRequest.NameStage roleId(@NotNull @NotNull String roleId)

      Your own identifier for the role. Must be 3 to 31 characters, starting with a lowercase letter and containing only lowercase letters, digits, and dashes (the same rules as a context ID). Required when creating a role; ignored when updating, since the role ID is taken from the URL path.

      Your own identifier for the role. Must be 3 to 31 characters, starting with a lowercase letter and containing only lowercase letters, digits, and dashes (the same rules as a context ID). Required when creating a role; ignored when updating, since the role ID is taken from the URL path.

      Specified by:
      roleId in interface RoleRequest.RoleIdStage
      Returns:
      Reference to this so that method calls can be chained together.

    • name

      public RoleRequest._FinalStage name(@NotNull @NotNull String name)

      A human-readable display name for the role.

      A human-readable display name for the role.

      Specified by:
      name in interface RoleRequest.NameStage
      Returns:
      Reference to this so that method calls can be chained together.

    • addAllScopes

      public RoleRequest._FinalStage addAllScopes(List<ScopeClause> scopes)

      The role's permissions, as one or more scope clauses. Each clause has allowed_actions (a list of permitted verbs) and data_scope (an attribute filter that restricts which records the actions apply to). An action is permitted if any clause allows that action and that clause's data scope matches the target record. To include records whose ownership field is null (account-level shared records), add null to the allowed values for that field.

      Specified by:
      addAllScopes in interface RoleRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • addScopes

      public RoleRequest._FinalStage addScopes(ScopeClause scopes)

      The role's permissions, as one or more scope clauses. Each clause has allowed_actions (a list of permitted verbs) and data_scope (an attribute filter that restricts which records the actions apply to). An action is permitted if any clause allows that action and that clause's data scope matches the target record. To include records whose ownership field is null (account-level shared records), add null to the allowed values for that field.

      Specified by:
      addScopes in interface RoleRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • scopes

      public RoleRequest._FinalStage scopes(List<ScopeClause> scopes)

      The role's permissions, as one or more scope clauses. Each clause has allowed_actions (a list of permitted verbs) and data_scope (an attribute filter that restricts which records the actions apply to). An action is permitted if any clause allows that action and that clause's data scope matches the target record. To include records whose ownership field is null (account-level shared records), add null to the allowed values for that field.

      Specified by:
      scopes in interface RoleRequest._FinalStage

    • description

      public RoleRequest._FinalStage description(String description)

      An optional free-text description of what the role grants.

      Specified by:
      description in interface RoleRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • description

      public RoleRequest._FinalStage description(Optional<String> description)

      An optional free-text description of what the role grants.

      Specified by:
      description in interface RoleRequest._FinalStage

    • build

      public RoleRequest build()
      Specified by:
      build in interface RoleRequest._FinalStage

    • additionalProperty

      public RoleRequest.Builder additionalProperty(String key, Object value)
      Specified by:
      additionalProperty in interface RoleRequest._FinalStage

    • additionalProperties

      public RoleRequest.Builder additionalProperties(Map<String,Object> additionalProperties)
      Specified by:
      additionalProperties in interface RoleRequest._FinalStage