com.google.api.services.dialogflow.v3.model.GoogleCloudDialogflowV2beta1EventInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dialogflow Show documentation
The newest version!
/*
 * 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.dialogflow.v3.model;

/**
 * Events allow for matching intents by event name instead of the natural language input. For
 * instance, input `` can trigger a personalized welcome response. The parameter `name` may be used
 * by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`.
 *
 *  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 Dialogflow 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 GoogleCloudDialogflowV2beta1EventInput extends com.google.api.client.json.GenericJson {

  /**
   * Required. The language of this query. See [Language
   * Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the
   * currently supported language codes. Note that queries in the same session do not necessarily
   * need to specify the same language. This field is ignored when used in the context of a
   * WebhookResponse.followup_event_input field, because the language was already defined in the
   * originating detect intent request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String languageCode;

  /**
   * Required. The unique identifier of the event.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The collection of parameters associated with the event. Depending on your protocol or client
   * library language, this is a map, associative array, symbol table, dictionary, or JSON object
   * composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value:
   * parameter name * MapValue type: If parameter's entity type is a composite entity then use map,
   * otherwise, depending on the parameter value type, it could be one of string, number, boolean,
   * null, list or map. * MapValue value: If parameter's entity type is a composite entity then use
   * map from composite entity property names to property values, otherwise, use parameter value.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map parameters;

  /**
   * Required. The language of this query. See [Language
   * Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the
   * currently supported language codes. Note that queries in the same session do not necessarily
   * need to specify the same language. This field is ignored when used in the context of a
   * WebhookResponse.followup_event_input field, because the language was already defined in the
   * originating detect intent request.
   * @return value or {@code null} for none
   */
  public java.lang.String getLanguageCode() {
    return languageCode;
  }

  /**
   * Required. The language of this query. See [Language
   * Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the
   * currently supported language codes. Note that queries in the same session do not necessarily
   * need to specify the same language. This field is ignored when used in the context of a
   * WebhookResponse.followup_event_input field, because the language was already defined in the
   * originating detect intent request.
   * @param languageCode languageCode or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1EventInput setLanguageCode(java.lang.String languageCode) {
    this.languageCode = languageCode;
    return this;
  }

  /**
   * Required. The unique identifier of the event.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Required. The unique identifier of the event.
   * @param name name or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1EventInput setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The collection of parameters associated with the event. Depending on your protocol or client
   * library language, this is a map, associative array, symbol table, dictionary, or JSON object
   * composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value:
   * parameter name * MapValue type: If parameter's entity type is a composite entity then use map,
   * otherwise, depending on the parameter value type, it could be one of string, number, boolean,
   * null, list or map. * MapValue value: If parameter's entity type is a composite entity then use
   * map from composite entity property names to property values, otherwise, use parameter value.
   * @return value or {@code null} for none
   */
  public java.util.Map getParameters() {
    return parameters;
  }

  /**
   * The collection of parameters associated with the event. Depending on your protocol or client
   * library language, this is a map, associative array, symbol table, dictionary, or JSON object
   * composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value:
   * parameter name * MapValue type: If parameter's entity type is a composite entity then use map,
   * otherwise, depending on the parameter value type, it could be one of string, number, boolean,
   * null, list or map. * MapValue value: If parameter's entity type is a composite entity then use
   * map from composite entity property names to property values, otherwise, use parameter value.
   * @param parameters parameters or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1EventInput setParameters(java.util.Map parameters) {
    this.parameters = parameters;
    return this;
  }

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

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

}