com.ibm.watson.conversationalskills.model.ConversationalSkillStateInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of conversationalskills-sdk Show documentation
SDK for creating Conversational Skills Pro-Code Provider
The newest version!
/*
 Copyright 2024 IBM Corporation

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */


package com.ibm.watson.conversationalskills.model;

import java.util.Objects;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

/**
 * ConversationalSkillStateInput
 */
@JsonPropertyOrder({
  ConversationalSkillStateInput.JSON_PROPERTY_LOCAL_VARIABLES,
  ConversationalSkillStateInput.JSON_PROPERTY_SESSION_VARIABLES,
  ConversationalSkillStateInput.JSON_PROPERTY_CURRENT_SLOT
})
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0")
public class ConversationalSkillStateInput {
  public static final String JSON_PROPERTY_LOCAL_VARIABLES = "local_variables";
  private Map localVariables = new HashMap<>();

  public static final String JSON_PROPERTY_SESSION_VARIABLES = "session_variables";
  private Map sessionVariables = new HashMap<>();

  public static final String JSON_PROPERTY_CURRENT_SLOT = "current_slot";
  private String currentSlot;

  public ConversationalSkillStateInput() {
  }

  public ConversationalSkillStateInput localVariables(Map localVariables) {
    
    this.localVariables = localVariables;
    return this;
  }

  public ConversationalSkillStateInput putLocalVariablesItem(String key, Object localVariablesItem) {
    if (this.localVariables == null) {
      this.localVariables = new HashMap<>();
    }
    this.localVariables.put(key, localVariablesItem);
    return this;
  }

  /**
   * Local scope variables that the conversational skill needs across turns to orchestrate the conversation.
   * @return localVariables
   */
  @jakarta.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_LOCAL_VARIABLES)
  @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)

  public Map getLocalVariables() {
    return localVariables;
  }


  @JsonProperty(JSON_PROPERTY_LOCAL_VARIABLES)
  @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
  public void setLocalVariables(Map localVariables) {
    this.localVariables = localVariables;
  }

  public ConversationalSkillStateInput sessionVariables(Map sessionVariables) {
    
    this.sessionVariables = sessionVariables;
    return this;
  }

  public ConversationalSkillStateInput putSessionVariablesItem(String key, Object sessionVariablesItem) {
    if (this.sessionVariables == null) {
      this.sessionVariables = new HashMap<>();
    }
    this.sessionVariables.put(key, sessionVariablesItem);
    return this;
  }

  /**
   * Conversation session scoped variables that the skill wants to share with other skills. These variables may live beyond the conclusion of the conversation being orchestrated by the skill.
   * @return sessionVariables
   */
  @jakarta.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_SESSION_VARIABLES)
  @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)

  public Map getSessionVariables() {
    return sessionVariables;
  }


  @JsonProperty(JSON_PROPERTY_SESSION_VARIABLES)
  @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
  public void setSessionVariables(Map sessionVariables) {
    this.sessionVariables = sessionVariables;
  }

  public ConversationalSkillStateInput currentSlot(String currentSlot) {
    
    this.currentSlot = currentSlot;
    return this;
  }

  /**
   * Reference to the currently prompted slot (name).
   * @return currentSlot
   */
  @jakarta.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_CURRENT_SLOT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getCurrentSlot() {
    return currentSlot;
  }


  @JsonProperty(JSON_PROPERTY_CURRENT_SLOT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCurrentSlot(String currentSlot) {
    this.currentSlot = currentSlot;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ConversationalSkillStateInput conversationalSkillStateInput = (ConversationalSkillStateInput) o;
    return Objects.equals(this.localVariables, conversationalSkillStateInput.localVariables) &&
        Objects.equals(this.sessionVariables, conversationalSkillStateInput.sessionVariables) &&
        Objects.equals(this.currentSlot, conversationalSkillStateInput.currentSlot);
  }

  @Override
  public int hashCode() {
    return Objects.hash(localVariables, sessionVariables, currentSlot);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ConversationalSkillStateInput {\n");
    sb.append("    localVariables: ").append(toIndentedString(localVariables)).append("\n");
    sb.append("    sessionVariables: ").append(toIndentedString(sessionVariables)).append("\n");
    sb.append("    currentSlot: ").append(toIndentedString(currentSlot)).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    ");
  }

}