com.unblu.webapi.model.v3.ApiKey Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of models-v3 Show documentation
Show all versions of models-v3 Show documentation
Java classes corresponding to the JSON bodies
package com.unblu.webapi.model.v3;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
* Model of an ApiKey. Api keys identify the usage of unblu to a certain account. There can be multiple api keys per account to define different configurations
*/
@ApiModel(description = "Model of an ApiKey. Api keys identify the usage of unblu to a certain account. There can be multiple api keys per account to define different configurations")
@JsonPropertyOrder({
ApiKey.JSON_PROPERTY_$_TYPE,
ApiKey.JSON_PROPERTY_ID,
ApiKey.JSON_PROPERTY_CREATION_TIMESTAMP,
ApiKey.JSON_PROPERTY_MODIFICATION_TIMESTAMP,
ApiKey.JSON_PROPERTY_VERSION,
ApiKey.JSON_PROPERTY_ACCOUNT_ID,
ApiKey.JSON_PROPERTY_API_KEY,
ApiKey.JSON_PROPERTY_NAME,
ApiKey.JSON_PROPERTY_DESCRIPTION,
ApiKey.JSON_PROPERTY_CONFIGURATION,
ApiKey.JSON_PROPERTY_TEXT,
ApiKey.JSON_PROPERTY_METADATA,
})
@JsonAutoDetect(creatorVisibility = Visibility.NONE, fieldVisibility = Visibility.NONE, getterVisibility = Visibility.NONE, isGetterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE)
public class ApiKey {
/**
* Gets or Sets $type
*/
public enum TypeEnum {
APIKEY("ApiKey");
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
return TypeEnum.APIKEY;
}
}
public static final String JSON_PROPERTY_$_TYPE = "$_type";
@JsonProperty(JSON_PROPERTY_$_TYPE)
private TypeEnum $type = TypeEnum.APIKEY;
public static final String JSON_PROPERTY_ID = "id";
@JsonProperty(JSON_PROPERTY_ID)
private String id;
public static final String JSON_PROPERTY_CREATION_TIMESTAMP = "creationTimestamp";
@JsonProperty(JSON_PROPERTY_CREATION_TIMESTAMP)
private Long creationTimestamp;
public static final String JSON_PROPERTY_MODIFICATION_TIMESTAMP = "modificationTimestamp";
@JsonProperty(JSON_PROPERTY_MODIFICATION_TIMESTAMP)
private Long modificationTimestamp;
public static final String JSON_PROPERTY_VERSION = "version";
@JsonProperty(JSON_PROPERTY_VERSION)
private Long version;
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
private String accountId;
public static final String JSON_PROPERTY_API_KEY = "apiKey";
@JsonProperty(JSON_PROPERTY_API_KEY)
private String apiKey;
public static final String JSON_PROPERTY_NAME = "name";
@JsonProperty(JSON_PROPERTY_NAME)
private String name;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
private String description;
public static final String JSON_PROPERTY_CONFIGURATION = "configuration";
@JsonProperty(JSON_PROPERTY_CONFIGURATION)
private Map _configuration = null;
public static final String JSON_PROPERTY_TEXT = "text";
@JsonProperty(JSON_PROPERTY_TEXT)
private Map> text = null;
public static final String JSON_PROPERTY_METADATA = "metadata";
@JsonProperty(JSON_PROPERTY_METADATA)
private Map metadata = null;
public ApiKey $type(TypeEnum $type) {
this.$type = $type;
return this;
}
/**
* Get $type
*
* @return $type
**/
@ApiModelProperty(value = "")
public TypeEnum get$Type() {
return $type;
}
public void set$Type(TypeEnum $type) {
this.$type = $type;
}
public ApiKey id(String id) {
this.id = id;
return this;
}
/**
* Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.
*
* @return id
**/
@ApiModelProperty(value = "Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public ApiKey creationTimestamp(Long creationTimestamp) {
this.creationTimestamp = creationTimestamp;
return this;
}
/**
* Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and
* therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data
* consistency.
*
* @return creationTimestamp
**/
@ApiModelProperty(value = "Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.")
public Long getCreationTimestamp() {
return creationTimestamp;
}
public void setCreationTimestamp(Long creationTimestamp) {
this.creationTimestamp = creationTimestamp;
}
public ApiKey modificationTimestamp(Long modificationTimestamp) {
this.modificationTimestamp = modificationTimestamp;
return this;
}
/**
* Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational
* character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it
* will not be written to the storage and will not effect the data consistency.
*
* @return modificationTimestamp
**/
@ApiModelProperty(value = "Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.")
public Long getModificationTimestamp() {
return modificationTimestamp;
}
public void setModificationTimestamp(Long modificationTimestamp) {
this.modificationTimestamp = modificationTimestamp;
}
public ApiKey version(Long version) {
this.version = version;
return this;
}
/**
* Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When
* creating an object, the version can be omitted.
*
* @return version
**/
@ApiModelProperty(value = "Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.")
public Long getVersion() {
return version;
}
public void setVersion(Long version) {
this.version = version;
}
public ApiKey accountId(String accountId) {
this.accountId = accountId;
return this;
}
/**
* ID of the account the entity belongs to. When creating an entity, the account ID can be omitted. It will be filled by the server with the account ID of the
* user currently logged in. When editing an entity, you must include the account ID.
*
* @return accountId
**/
@ApiModelProperty(value = "ID of the account the entity belongs to. When creating an entity, the account ID can be omitted. It will be filled by the server with the account ID of the user currently logged in. When editing an entity, you must include the account ID.")
public String getAccountId() {
return accountId;
}
public void setAccountId(String accountId) {
this.accountId = accountId;
}
public ApiKey apiKey(String apiKey) {
this.apiKey = apiKey;
return this;
}
/**
* Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server).
* Can not be updated.
*
* @return apiKey
**/
@ApiModelProperty(value = "Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server). Can not be updated.")
public String getApiKey() {
return apiKey;
}
public void setApiKey(String apiKey) {
this.apiKey = apiKey;
}
public ApiKey name(String name) {
this.name = name;
return this;
}
/**
* Name of the api key. Maximum of 250 characters. Can be omitted, but should not.
*
* @return name
**/
@ApiModelProperty(value = "Name of the api key. Maximum of 250 characters. Can be omitted, but should not.")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public ApiKey description(String description) {
this.description = description;
return this;
}
/**
* Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted.
*
* @return description
**/
@ApiModelProperty(value = "Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted.")
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public ApiKey _configuration(Map _configuration) {
this._configuration = _configuration;
return this;
}
public ApiKey putConfigurationItem(String key, String _configurationItem) {
if (this._configuration == null) {
this._configuration = new HashMap<>();
}
this._configuration.put(key, _configurationItem);
return this;
}
/**
* The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. Not
* filled in webhook events.
*
* @return _configuration
**/
@ApiModelProperty(value = "The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. Not filled in webhook events.")
public Map getConfiguration() {
return _configuration;
}
public void setConfiguration(Map _configuration) {
this._configuration = _configuration;
}
public ApiKey text(Map> text) {
this.text = text;
return this;
}
public ApiKey putTextItem(String key, Map textItem) {
if (this.text == null) {
this.text = new HashMap<>();
}
this.text.put(key, textItem);
return this;
}
/**
* The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. Not filled in webhook
* events.
*
* @return text
**/
@ApiModelProperty(value = "The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. Not filled in webhook events.")
public Map> getText() {
return text;
}
public void setText(Map> text) {
this.text = text;
}
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;
}
/**
* The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. Not filled in
* webhook events.
*
* @return metadata
**/
@ApiModelProperty(value = "The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. Not filled in webhook events.")
public Map getMetadata() {
return metadata;
}
public void setMetadata(Map metadata) {
this.metadata = metadata;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ApiKey apiKey = (ApiKey) o;
return Objects.equals(this.$type, apiKey.$type) &&
Objects.equals(this.id, apiKey.id) &&
Objects.equals(this.creationTimestamp, apiKey.creationTimestamp) &&
Objects.equals(this.modificationTimestamp, apiKey.modificationTimestamp) &&
Objects.equals(this.version, apiKey.version) &&
Objects.equals(this.accountId, apiKey.accountId) &&
Objects.equals(this.apiKey, apiKey.apiKey) &&
Objects.equals(this.name, apiKey.name) &&
Objects.equals(this.description, apiKey.description) &&
Objects.equals(this._configuration, apiKey._configuration) &&
Objects.equals(this.text, apiKey.text) &&
Objects.equals(this.metadata, apiKey.metadata);
}
@Override
public int hashCode() {
return Objects.hash($type, id, creationTimestamp, modificationTimestamp, version, accountId, apiKey, name, description, _configuration, text, metadata);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ApiKey {\n");
sb.append(" $type: ").append(toIndentedString($type)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" creationTimestamp: ").append(toIndentedString(creationTimestamp)).append("\n");
sb.append(" modificationTimestamp: ").append(toIndentedString(modificationTimestamp)).append("\n");
sb.append(" version: ").append(toIndentedString(version)).append("\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" apiKey: ").append(toIndentedString(apiKey)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" _configuration: ").append(toIndentedString(_configuration)).append("\n");
sb.append(" text: ").append(toIndentedString(text)).append("\n");
sb.append(" metadata: ").append(toIndentedString(metadata)).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(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}