io.permit.sdk.openapi.models.RoleCreate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of permit-sdk-java Show documentation
Java SDK for Permit.io: fullstack permissions for cloud native applications
There is a newer version: 983f46e

package io.permit.sdk.openapi.models;

import java.util.HashMap;
import java.util.List;
import javax.annotation.Generated;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;


/**
 * RoleCreate
 * 
 * 
 * 
 */
@Generated("jsonschema2pojo")
public class RoleCreate {

    /**
     * Key
     * 

     * A URL-friendly name of the role (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the role.
     * (Required)
     * 
     */
    @SerializedName("key")
    @Expose
    public String key;
    /**
     * Name
     * 

     * The name of the role
     * (Required)
     * 
     */
    @SerializedName("name")
    @Expose
    public String name;
    /**
     * Description
     * 

     * optional description string explaining what this role represents, or what permissions are granted to it.
     * 
     */
    @SerializedName("description")
    @Expose
    public String description;
    /**
     * Permissions
     * 

     * list of action keys that define what actions this resource role is permitted to do
     * 
     */
    @SerializedName("permissions")
    @Expose
    public List permissions;
    /**
     * Attributes
     * 

     * optional dictionary of key-value pairs that can be used to store arbitrary metadata about this role. This metadata can be used to filter role using query parameters with attr_ prefix, currently supports only 'equals' operator
     * 
     */
    @SerializedName("attributes")
    @Expose
    public HashMap attributes;
    /**
     * Extends
     * 

     * list of role keys that define what roles this role extends. In other words: this role will automatically inherit all the permissions of the given roles in this list.
     * 
     */
    @SerializedName("extends")
    @Expose
    public List _extends;
    /**
     * Granted To
     * 
     * Derived role that inherit will be applied on this role
     * 
     */
    @SerializedName("granted_to")
    @Expose
    public DerivedRoleBlockEdit grantedTo;

    /**
     * No args constructor for use in serialization
     * 
     */
    public RoleCreate() {
    }

    /**
     * 
     * @param name
     * @param key
     */
    public RoleCreate(String key, String name) {
        super();
        this.key = key;
        this.name = name;
    }

    public RoleCreate withKey(String key) {
        this.key = key;
        return this;
    }

    public RoleCreate withName(String name) {
        this.name = name;
        return this;
    }

    public RoleCreate withDescription(String description) {
        this.description = description;
        return this;
    }

    public RoleCreate withPermissions(List permissions) {
        this.permissions = permissions;
        return this;
    }

    public RoleCreate withAttributes(HashMap attributes) {
        this.attributes = attributes;
        return this;
    }

    public RoleCreate withExtends(List _extends) {
        this._extends = _extends;
        return this;
    }

    public RoleCreate withGrantedTo(DerivedRoleBlockEdit grantedTo) {
        this.grantedTo = grantedTo;
        return this;
    }

}