com.salesforce.einsteinbot.sdk.model.EndSessionMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of einstein-bot-sdk-java Show documentation
Java SDK to interact with Einstein Bots Runtime. This SDK is a wrapper around the Einstein Bots Runtime API that provides a few added features out of the box like Auth support, Session management
There is a newer version: 2.3.0
Show newest version
/*
 * Einstein Bots API (BETA)
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v4
 * 
 *
 * 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.salesforce.einsteinbot.sdk.model;

import java.util.Objects;
import java.util.Arrays;
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 io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * Client request to end the session
 */
@ApiModel(description = "Client request to end the session")
@JsonPropertyOrder({
  EndSessionMessage.JSON_PROPERTY_TYPE,
  EndSessionMessage.JSON_PROPERTY_SEQUENCE_ID,
  EndSessionMessage.JSON_PROPERTY_IN_REPLY_TO_MESSAGE_ID,
  EndSessionMessage.JSON_PROPERTY_REASON
})
@JsonTypeName("EndSessionMessage")
@javax.annotation.Generated(value = "com.salesforce.einsteinbot.openapi.codegen.EinsteinBotCodeGenerator", date = "2022-03-24T00:55:11.933462Z[Etc/UTC]")
public class EndSessionMessage   implements AnyRequestMessage  {
  /**
   * Message type
   */
  public enum TypeEnum {
    ENDSESSION("endSession");

    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;
        }
      }
      throw new IllegalArgumentException("Unexpected value '" + value + "'");
    }
  }

  public static final String JSON_PROPERTY_TYPE = "type";
  private TypeEnum type;

  public static final String JSON_PROPERTY_SEQUENCE_ID = "sequenceId";
  private Long sequenceId;

  public static final String JSON_PROPERTY_IN_REPLY_TO_MESSAGE_ID = "inReplyToMessageId";
  private String inReplyToMessageId;

  /**
   * Reason the client wishes to end the session
   */
  public enum ReasonEnum {
    USERREQUEST("UserRequest"),
    
    TRANSFER("Transfer"),
    
    EXPIRATION("Expiration"),
    
    ERROR("Error"),
    
    OTHER("Other");

    private String value;

    ReasonEnum(String value) {
      this.value = value;
    }

    @JsonValue
    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }

    @JsonCreator
    public static ReasonEnum fromValue(String value) {
      for (ReasonEnum b : ReasonEnum.values()) {
        if (b.value.equals(value)) {
          return b;
        }
      }
      throw new IllegalArgumentException("Unexpected value '" + value + "'");
    }
  }

  public static final String JSON_PROPERTY_REASON = "reason";
  private ReasonEnum reason;

  public EndSessionMessage() { 
  }

  public EndSessionMessage type(TypeEnum type) {
    
    this.type = type;
    return this;
  }

   /**
   * Message type
   * @return type
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "endSession", required = true, value = "Message type")
  @JsonProperty(JSON_PROPERTY_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public TypeEnum getType() {
    return type;
  }


  @JsonProperty(JSON_PROPERTY_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setType(TypeEnum type) {
    this.type = type;
  }


  public EndSessionMessage sequenceId(Long sequenceId) {
    
    this.sequenceId = sequenceId;
    return this;
  }

   /**
   * Client generated message number (must be ever increasing within the same session)
   * @return sequenceId
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "1", required = true, value = "Client generated message number (must be ever increasing within the same session)")
  @JsonProperty(JSON_PROPERTY_SEQUENCE_ID)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public Long getSequenceId() {
    return sequenceId;
  }


  @JsonProperty(JSON_PROPERTY_SEQUENCE_ID)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setSequenceId(Long sequenceId) {
    this.sequenceId = sequenceId;
  }


  public EndSessionMessage inReplyToMessageId(String inReplyToMessageId) {
    
    this.inReplyToMessageId = inReplyToMessageId;
    return this;
  }

   /**
   * Message ID from the previous response you are replying to
   * @return inReplyToMessageId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "a133c185-73a7-4adf-b6d9-b7fd62babb4e", value = "Message ID from the previous response you are replying to")
  @JsonProperty(JSON_PROPERTY_IN_REPLY_TO_MESSAGE_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getInReplyToMessageId() {
    return inReplyToMessageId;
  }


  @JsonProperty(JSON_PROPERTY_IN_REPLY_TO_MESSAGE_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setInReplyToMessageId(String inReplyToMessageId) {
    this.inReplyToMessageId = inReplyToMessageId;
  }


  public EndSessionMessage reason(ReasonEnum reason) {
    
    this.reason = reason;
    return this;
  }

   /**
   * Reason the client wishes to end the session
   * @return reason
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "Transfer", required = true, value = "Reason the client wishes to end the session")
  @JsonProperty(JSON_PROPERTY_REASON)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public ReasonEnum getReason() {
    return reason;
  }


  @JsonProperty(JSON_PROPERTY_REASON)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setReason(ReasonEnum reason) {
    this.reason = reason;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    EndSessionMessage endSessionMessage = (EndSessionMessage) o;
    return Objects.equals(this.type, endSessionMessage.type) &&
        Objects.equals(this.sequenceId, endSessionMessage.sequenceId) &&
        Objects.equals(this.inReplyToMessageId, endSessionMessage.inReplyToMessageId) &&
        Objects.equals(this.reason, endSessionMessage.reason);
  }

  @Override
  public int hashCode() {
    return Objects.hash(type, sequenceId, inReplyToMessageId, reason);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class EndSessionMessage {\n");
    sb.append("    type: ").append(toIndentedString(type)).append("\n");
    sb.append("    sequenceId: ").append(toIndentedString(sequenceId)).append("\n");
    sb.append("    inReplyToMessageId: ").append(toIndentedString(inReplyToMessageId)).append("\n");
    sb.append("    reason: ").append(toIndentedString(reason)).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    ");
  }

}