com.google.api.services.contactcenterinsights.v1.model.GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction Maven / Gradle / Ivy

Go to download
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.contactcenterinsights.v1.model;

/**
 * Agent Coaching instructions that customer can configure.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Contact Center AI Insights API. For a detailed
 * explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction extends com.google.api.client.json.GenericJson {

  /**
   * Optional. The action that human agent should take. For example, "apologize for the slow
   * shipping". If the users only want to use agent coaching for intent detection, agent_action can
   * be empty
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String agentAction;

  /**
   * Optional. The condition of the instruction. For example, "the customer wants to cancel an
   * order". If the users want the instruction to be triggered unconditionally, the condition can be
   * empty.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String condition;

  /**
   * Optional. The detailed description of this instruction.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * Optional. Display name for the instruction.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Optional. Additional information attached to this instruction.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map metadata;

  /**
   * Optional. The action that system should take. For example, "call GetOrderTime with
   * order_number={order number provided by the customer}". If the users don't have plugins or don't
   * want to trigger plugins, the system_action can be empty
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String systemAction;

  /**
   * Optional. The action that human agent should take. For example, "apologize for the slow
   * shipping". If the users only want to use agent coaching for intent detection, agent_action can
   * be empty
   * @return value or {@code null} for none
   */
  public java.lang.String getAgentAction() {
    return agentAction;
  }

  /**
   * Optional. The action that human agent should take. For example, "apologize for the slow
   * shipping". If the users only want to use agent coaching for intent detection, agent_action can
   * be empty
   * @param agentAction agentAction or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction setAgentAction(java.lang.String agentAction) {
    this.agentAction = agentAction;
    return this;
  }

  /**
   * Optional. The condition of the instruction. For example, "the customer wants to cancel an
   * order". If the users want the instruction to be triggered unconditionally, the condition can be
   * empty.
   * @return value or {@code null} for none
   */
  public java.lang.String getCondition() {
    return condition;
  }

  /**
   * Optional. The condition of the instruction. For example, "the customer wants to cancel an
   * order". If the users want the instruction to be triggered unconditionally, the condition can be
   * empty.
   * @param condition condition or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction setCondition(java.lang.String condition) {
    this.condition = condition;
    return this;
  }

  /**
   * Optional. The detailed description of this instruction.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * Optional. The detailed description of this instruction.
   * @param description description or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * Optional. Display name for the instruction.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Optional. Display name for the instruction.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * Optional. Additional information attached to this instruction.
   * @return value or {@code null} for none
   */
  public java.util.Map getMetadata() {
    return metadata;
  }

  /**
   * Optional. Additional information attached to this instruction.
   * @param metadata metadata or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction setMetadata(java.util.Map metadata) {
    this.metadata = metadata;
    return this;
  }

  /**
   * Optional. The action that system should take. For example, "call GetOrderTime with
   * order_number={order number provided by the customer}". If the users don't have plugins or don't
   * want to trigger plugins, the system_action can be empty
   * @return value or {@code null} for none
   */
  public java.lang.String getSystemAction() {
    return systemAction;
  }

  /**
   * Optional. The action that system should take. For example, "call GetOrderTime with
   * order_number={order number provided by the customer}". If the users don't have plugins or don't
   * want to trigger plugins, the system_action can be empty
   * @param systemAction systemAction or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction setSystemAction(java.lang.String systemAction) {
    this.systemAction = systemAction;
    return this;
  }

  @Override
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction set(String fieldName, Object value) {
    return (GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction clone() {
    return (GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction) super.clone();
  }

}