localhost.models.ApiRestV2GroupUpdateRequest Maven / Gradle / Ivy
/*
* RESTAPISDKLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
package localhost.models;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonSetter;
import java.util.List;
/**
* This is a model class for ApiRestV2GroupUpdateRequest type.
*/
public class ApiRestV2GroupUpdateRequest {
private String name;
private String id;
private String displayName;
private Visibility3Enum visibility;
private String description;
private List privileges;
private List groups;
private List users;
private List assignedLiveboards;
private Type5Enum type;
/**
* Default constructor.
*/
public ApiRestV2GroupUpdateRequest() {
visibility = Visibility3Enum.DEFAULT;
type = Type5Enum.LOCAL_GROUP;
}
/**
* Initialization constructor.
* @param name String value for name.
* @param id String value for id.
* @param displayName String value for displayName.
* @param visibility Visibility3Enum value for visibility.
* @param description String value for description.
* @param privileges List of PrivilegeEnum value for privileges.
* @param groups List of GroupNameAndIDInput value for groups.
* @param users List of UserNameAndIDInput value for users.
* @param assignedLiveboards List of String value for assignedLiveboards.
* @param type Type5Enum value for type.
*/
public ApiRestV2GroupUpdateRequest(
String name,
String id,
String displayName,
Visibility3Enum visibility,
String description,
List privileges,
List groups,
List users,
List assignedLiveboards,
Type5Enum type) {
this.name = name;
this.id = id;
this.displayName = displayName;
this.visibility = visibility;
this.description = description;
this.privileges = privileges;
this.groups = groups;
this.users = users;
this.assignedLiveboards = assignedLiveboards;
this.type = type;
}
/**
* Getter for Name.
* Name of the user group
* @return Returns the String
*/
@JsonGetter("name")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getName() {
return name;
}
/**
* Setter for Name.
* Name of the user group
* @param name Value for String
*/
@JsonSetter("name")
public void setName(String name) {
this.name = name;
}
/**
* Getter for Id.
* GUID of the group to update
* @return Returns the String
*/
@JsonGetter("id")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getId() {
return id;
}
/**
* Setter for Id.
* GUID of the group to update
* @param id Value for String
*/
@JsonSetter("id")
public void setId(String id) {
this.id = id;
}
/**
* Getter for DisplayName.
* A unique display name string for the user group, for example, Developer group.
* @return Returns the String
*/
@JsonGetter("displayName")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getDisplayName() {
return displayName;
}
/**
* Setter for DisplayName.
* A unique display name string for the user group, for example, Developer group.
* @param displayName Value for String
*/
@JsonSetter("displayName")
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
* Getter for Visibility.
* Visibility of the user group. The visibility attribute is set to DEFAULT. The DEFAULT
* attribute makes the user group visible for other user groups and allows them to share
* objects.
* @return Returns the Visibility3Enum
*/
@JsonGetter("visibility")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Visibility3Enum getVisibility() {
return visibility;
}
/**
* Setter for Visibility.
* Visibility of the user group. The visibility attribute is set to DEFAULT. The DEFAULT
* attribute makes the user group visible for other user groups and allows them to share
* objects.
* @param visibility Value for Visibility3Enum
*/
@JsonSetter("visibility")
public void setVisibility(Visibility3Enum visibility) {
this.visibility = visibility;
}
/**
* Getter for Description.
* Description text for the group.
* @return Returns the String
*/
@JsonGetter("description")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getDescription() {
return description;
}
/**
* Setter for Description.
* Description text for the group.
* @param description Value for String
*/
@JsonSetter("description")
public void setDescription(String description) {
this.description = description;
}
/**
* Getter for Privileges.
* A JSON array of privileges assigned to the group
* @return Returns the List of PrivilegeEnum
*/
@JsonGetter("privileges")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getPrivileges() {
return privileges;
}
/**
* Setter for Privileges.
* A JSON array of privileges assigned to the group
* @param privileges Value for List of PrivilegeEnum
*/
@JsonSetter("privileges")
public void setPrivileges(List privileges) {
this.privileges = privileges;
}
/**
* Getter for Groups.
* A JSON array of group names or GUIDs or both. When both are given then id is considered
* @return Returns the List of GroupNameAndIDInput
*/
@JsonGetter("groups")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getGroups() {
return groups;
}
/**
* Setter for Groups.
* A JSON array of group names or GUIDs or both. When both are given then id is considered
* @param groups Value for List of GroupNameAndIDInput
*/
@JsonSetter("groups")
public void setGroups(List groups) {
this.groups = groups;
}
/**
* Getter for Users.
* A JSON array of name of users or GUIDs of users or both. When both are given then id is
* considered
* @return Returns the List of UserNameAndIDInput
*/
@JsonGetter("users")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getUsers() {
return users;
}
/**
* Setter for Users.
* A JSON array of name of users or GUIDs of users or both. When both are given then id is
* considered
* @param users Value for List of UserNameAndIDInput
*/
@JsonSetter("users")
public void setUsers(List users) {
this.users = users;
}
/**
* Getter for AssignedLiveboards.
* An array of liveboard ids to be assigned to the group.
* @return Returns the List of String
*/
@JsonGetter("assignedLiveboards")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getAssignedLiveboards() {
return assignedLiveboards;
}
/**
* Setter for AssignedLiveboards.
* An array of liveboard ids to be assigned to the group.
* @param assignedLiveboards Value for List of String
*/
@JsonSetter("assignedLiveboards")
public void setAssignedLiveboards(List assignedLiveboards) {
this.assignedLiveboards = assignedLiveboards;
}
/**
* Getter for Type.
* Type of user group. LOCAL_GROUP indicates that the user is created locally in the ThoughtSpot
* system.
* @return Returns the Type5Enum
*/
@JsonGetter("type")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Type5Enum getType() {
return type;
}
/**
* Setter for Type.
* Type of user group. LOCAL_GROUP indicates that the user is created locally in the ThoughtSpot
* system.
* @param type Value for Type5Enum
*/
@JsonSetter("type")
public void setType(Type5Enum type) {
this.type = type;
}
/**
* Converts this ApiRestV2GroupUpdateRequest into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "ApiRestV2GroupUpdateRequest [" + "name=" + name + ", id=" + id + ", displayName="
+ displayName + ", visibility=" + visibility + ", description=" + description
+ ", privileges=" + privileges + ", groups=" + groups + ", users=" + users
+ ", assignedLiveboards=" + assignedLiveboards + ", type=" + type + "]";
}
/**
* Builds a new {@link ApiRestV2GroupUpdateRequest.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link ApiRestV2GroupUpdateRequest.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder()
.name(getName())
.id(getId())
.displayName(getDisplayName())
.visibility(getVisibility())
.description(getDescription())
.privileges(getPrivileges())
.groups(getGroups())
.users(getUsers())
.assignedLiveboards(getAssignedLiveboards())
.type(getType());
return builder;
}
/**
* Class to build instances of {@link ApiRestV2GroupUpdateRequest}.
*/
public static class Builder {
private String name;
private String id;
private String displayName;
private Visibility3Enum visibility = Visibility3Enum.DEFAULT;
private String description;
private List privileges;
private List groups;
private List users;
private List assignedLiveboards;
private Type5Enum type = Type5Enum.LOCAL_GROUP;
/**
* Setter for name.
* @param name String value for name.
* @return Builder
*/
public Builder name(String name) {
this.name = name;
return this;
}
/**
* Setter for id.
* @param id String value for id.
* @return Builder
*/
public Builder id(String id) {
this.id = id;
return this;
}
/**
* Setter for displayName.
* @param displayName String value for displayName.
* @return Builder
*/
public Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* Setter for visibility.
* @param visibility Visibility3Enum value for visibility.
* @return Builder
*/
public Builder visibility(Visibility3Enum visibility) {
this.visibility = visibility;
return this;
}
/**
* Setter for description.
* @param description String value for description.
* @return Builder
*/
public Builder description(String description) {
this.description = description;
return this;
}
/**
* Setter for privileges.
* @param privileges List of PrivilegeEnum value for privileges.
* @return Builder
*/
public Builder privileges(List privileges) {
this.privileges = privileges;
return this;
}
/**
* Setter for groups.
* @param groups List of GroupNameAndIDInput value for groups.
* @return Builder
*/
public Builder groups(List groups) {
this.groups = groups;
return this;
}
/**
* Setter for users.
* @param users List of UserNameAndIDInput value for users.
* @return Builder
*/
public Builder users(List users) {
this.users = users;
return this;
}
/**
* Setter for assignedLiveboards.
* @param assignedLiveboards List of String value for assignedLiveboards.
* @return Builder
*/
public Builder assignedLiveboards(List assignedLiveboards) {
this.assignedLiveboards = assignedLiveboards;
return this;
}
/**
* Setter for type.
* @param type Type5Enum value for type.
* @return Builder
*/
public Builder type(Type5Enum type) {
this.type = type;
return this;
}
/**
* Builds a new {@link ApiRestV2GroupUpdateRequest} object using the set fields.
* @return {@link ApiRestV2GroupUpdateRequest}
*/
public ApiRestV2GroupUpdateRequest build() {
return new ApiRestV2GroupUpdateRequest(name, id, displayName, visibility, description,
privileges, groups, users, assignedLiveboards, type);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy