com.ziqni.admin.sdk.model.ApiKey Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ziqni-admin-sdk Show documentation
Show all versions of ziqni-admin-sdk Show documentation
ZIQNI Admin SDK Java Client
/*
* ZIQNI Admin API
* Ziqni Application Services are used to manage and configure spaces.
*
* The version of the OpenAPI document: 3.0.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.ziqni.admin.sdk.model;
import java.util.Objects;
import java.util.Arrays;
import java.util.Map;
import java.util.HashMap;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import com.ziqni.admin.sdk.model.ApiKeyAllOf;
import com.ziqni.admin.sdk.model.ModelDefault;
import com.ziqni.admin.sdk.model.OptParamModels;
import com.ziqni.admin.sdk.model.Role;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
/**
* ApiKey
*/
@JsonPropertyOrder({
ApiKey.JSON_PROPERTY_ID,
ApiKey.JSON_PROPERTY_SPACE_NAME,
ApiKey.JSON_PROPERTY_CREATED,
ApiKey.JSON_PROPERTY_CUSTOM_FIELDS,
ApiKey.JSON_PROPERTY_TAGS,
ApiKey.JSON_PROPERTY_METADATA,
ApiKey.JSON_PROPERTY_DESCRIPTION,
ApiKey.JSON_PROPERTY_WHITE_LIST_I_PS,
ApiKey.JSON_PROPERTY_KEY,
ApiKey.JSON_PROPERTY_ROLE,
ApiKey.JSON_PROPERTY_CONSTRAINTS
})
@javax.annotation.processing.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class ApiKey {
public static final String JSON_PROPERTY_ID = "id";
private String id;
public static final String JSON_PROPERTY_SPACE_NAME = "spaceName";
private String spaceName;
public static final String JSON_PROPERTY_CREATED = "created";
private OffsetDateTime created;
public static final String JSON_PROPERTY_CUSTOM_FIELDS = "customFields";
private Map customFields = null;
public static final String JSON_PROPERTY_TAGS = "tags";
private List tags = null;
public static final String JSON_PROPERTY_METADATA = "metadata";
private Map metadata = null;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;
public static final String JSON_PROPERTY_WHITE_LIST_I_PS = "whiteListIPs";
private List whiteListIPs = null;
public static final String JSON_PROPERTY_KEY = "key";
private String key;
public static final String JSON_PROPERTY_ROLE = "role";
private Role role;
public static final String JSON_PROPERTY_CONSTRAINTS = "constraints";
private List constraints = new ArrayList<>();
public ApiKey id(String id) {
this.id = id;
return this;
}
/**
* A unique system generated identifier
* @return id
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "sc1samQmVr61KgaPQq7x", required = true, value = "A unique system generated identifier")
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getId() {
return id;
}
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setId(String id) {
this.id = id;
}
public ApiKey spaceName(String spaceName) {
this.spaceName = spaceName;
return this;
}
/**
* This is the space name which is linked to the account
* @return spaceName
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "Your_space_name", required = true, value = "This is the space name which is linked to the account")
@JsonProperty(JSON_PROPERTY_SPACE_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getSpaceName() {
return spaceName;
}
@JsonProperty(JSON_PROPERTY_SPACE_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSpaceName(String spaceName) {
this.spaceName = spaceName;
}
public ApiKey created(OffsetDateTime created) {
this.created = created;
return this;
}
/**
* ISO8601 timestamp for when a Model was created. All records are stored in UTC time zone
* @return created
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "ISO8601 timestamp for when a Model was created. All records are stored in UTC time zone")
@JsonProperty(JSON_PROPERTY_CREATED)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public OffsetDateTime getCreated() {
return created;
}
@JsonProperty(JSON_PROPERTY_CREATED)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCreated(OffsetDateTime created) {
this.created = created;
}
public ApiKey customFields(Map customFields) {
this.customFields = customFields;
return this;
}
public ApiKey putCustomFieldsItem(String key, Object customFieldsItem) {
if (this.customFields == null) {
this.customFields = new HashMap<>();
}
this.customFields.put(key, customFieldsItem);
return this;
}
/**
* Get customFields
* @return customFields
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS)
@JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
public Map getCustomFields() {
return customFields;
}
@JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS)
@JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
public void setCustomFields(Map customFields) {
this.customFields = customFields;
}
public ApiKey tags(List tags) {
this.tags = tags;
return this;
}
public ApiKey addTagsItem(String tagsItem) {
if (this.tags == null) {
this.tags = new ArrayList<>();
}
this.tags.add(tagsItem);
return this;
}
/**
* A list of id's used to tag models
* @return tags
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "A list of id's used to tag models")
@JsonProperty(JSON_PROPERTY_TAGS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getTags() {
return tags;
}
@JsonProperty(JSON_PROPERTY_TAGS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTags(List tags) {
this.tags = tags;
}
public ApiKey metadata(Map metadata) {
this.metadata = metadata;
return this;
}
public ApiKey putMetadataItem(String key, String metadataItem) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.put(key, metadataItem);
return this;
}
/**
* Get metadata
* @return metadata
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_METADATA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Map getMetadata() {
return metadata;
}
@JsonProperty(JSON_PROPERTY_METADATA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMetadata(Map metadata) {
this.metadata = metadata;
}
public ApiKey description(String description) {
this.description = description;
return this;
}
/**
* The description of an Api key
* @return description
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "User api key", value = "The description of an Api key")
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDescription(String description) {
this.description = description;
}
public ApiKey whiteListIPs(List whiteListIPs) {
this.whiteListIPs = whiteListIPs;
return this;
}
public ApiKey addWhiteListIPsItem(String whiteListIPsItem) {
if (this.whiteListIPs == null) {
this.whiteListIPs = new ArrayList<>();
}
this.whiteListIPs.add(whiteListIPsItem);
return this;
}
/**
* the IP's that need to be whitelisted with the Api key
* @return whiteListIPs
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "[\"123.221.22.1\",\"333.224.34.1\"]", value = "the IP's that need to be whitelisted with the Api key")
@JsonProperty(JSON_PROPERTY_WHITE_LIST_I_PS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getWhiteListIPs() {
return whiteListIPs;
}
@JsonProperty(JSON_PROPERTY_WHITE_LIST_I_PS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setWhiteListIPs(List whiteListIPs) {
this.whiteListIPs = whiteListIPs;
}
public ApiKey key(String key) {
this.key = key;
return this;
}
/**
* An Api key hash
* @return key
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "UUID.randomUUID.toString.replace", required = true, value = "An Api key hash")
@JsonProperty(JSON_PROPERTY_KEY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getKey() {
return key;
}
@JsonProperty(JSON_PROPERTY_KEY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setKey(String key) {
this.key = key;
}
public ApiKey role(Role role) {
this.role = role;
return this;
}
/**
* Get role
* @return role
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_ROLE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Role getRole() {
return role;
}
@JsonProperty(JSON_PROPERTY_ROLE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setRole(Role role) {
this.role = role;
}
public ApiKey constraints(List constraints) {
this.constraints = constraints;
return this;
}
public ApiKey addConstraintsItem(String constraintsItem) {
this.constraints.add(constraintsItem);
return this;
}
/**
* Additional constraints
* @return constraints
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "- active - default", required = true, value = "Additional constraints")
@JsonProperty(JSON_PROPERTY_CONSTRAINTS)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public List getConstraints() {
return constraints;
}
@JsonProperty(JSON_PROPERTY_CONSTRAINTS)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setConstraints(List constraints) {
this.constraints = constraints;
}
/**
* Return true if this ApiKey object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ApiKey apiKey = (ApiKey) o;
return Objects.equals(this.id, apiKey.id) &&
Objects.equals(this.spaceName, apiKey.spaceName) &&
Objects.equals(this.created, apiKey.created) &&
Objects.equals(this.customFields, apiKey.customFields) &&
Objects.equals(this.tags, apiKey.tags) &&
Objects.equals(this.metadata, apiKey.metadata) &&
Objects.equals(this.description, apiKey.description) &&
Objects.equals(this.whiteListIPs, apiKey.whiteListIPs) &&
Objects.equals(this.key, apiKey.key) &&
Objects.equals(this.role, apiKey.role) &&
Objects.equals(this.constraints, apiKey.constraints);
}
@Override
public int hashCode() {
return Objects.hash(id, spaceName, created, customFields, tags, metadata, description, whiteListIPs, key, role, constraints);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ApiKey {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" spaceName: ").append(toIndentedString(spaceName)).append("\n");
sb.append(" created: ").append(toIndentedString(created)).append("\n");
sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" whiteListIPs: ").append(toIndentedString(whiteListIPs)).append("\n");
sb.append(" key: ").append(toIndentedString(key)).append("\n");
sb.append(" role: ").append(toIndentedString(role)).append("\n");
sb.append(" constraints: ").append(toIndentedString(constraints)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}