com.google.api.services.dialogflow.v3.model.GoogleCloudDialogflowCxV3Environment 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;

/**
 * Represents an environment for an agent. You can create multiple versions of your agent and
 * publish them to separate environments. When you edit an agent, you are editing the draft agent.
 * At any point, you can save the draft agent as an agent version, which is an immutable snapshot of
 * your agent. When you save the draft agent, it is published to the default environment. When you
 * create agent versions, you can publish them to custom environments. You can create a variety of
 * custom environments for testing, development, production, etc.
 *
 *  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 GoogleCloudDialogflowCxV3Environment extends com.google.api.client.json.GenericJson {

  /**
   * The human-readable description of the environment. The maximum length is 500 characters. If
   * exceeded, the request is rejected.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * Required. The human-readable name of the environment (unique in an agent). Limit of 64
   * characters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * The name of the environment. Format: `projects//locations//agents//environments/`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The test cases config for continuous tests of this environment.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig testCasesConfig;

  /**
   * Output only. Update time of this environment.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String updateTime;

  /**
   * A list of configurations for flow versions. You should include version configs for all flows
   * that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List versionConfigs;

  /**
   * The webhook configuration for this environment.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3EnvironmentWebhookConfig webhookConfig;

  /**
   * The human-readable description of the environment. The maximum length is 500 characters. If
   * exceeded, the request is rejected.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * The human-readable description of the environment. The maximum length is 500 characters. If
   * exceeded, the request is rejected.
   * @param description description or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3Environment setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * Required. The human-readable name of the environment (unique in an agent). Limit of 64
   * characters.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Required. The human-readable name of the environment (unique in an agent). Limit of 64
   * characters.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3Environment setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * The name of the environment. Format: `projects//locations//agents//environments/`.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of the environment. Format: `projects//locations//agents//environments/`.
   * @param name name or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3Environment setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The test cases config for continuous tests of this environment.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig getTestCasesConfig() {
    return testCasesConfig;
  }

  /**
   * The test cases config for continuous tests of this environment.
   * @param testCasesConfig testCasesConfig or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3Environment setTestCasesConfig(GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig testCasesConfig) {
    this.testCasesConfig = testCasesConfig;
    return this;
  }

  /**
   * Output only. Update time of this environment.
   * @return value or {@code null} for none
   */
  public String getUpdateTime() {
    return updateTime;
  }

  /**
   * Output only. Update time of this environment.
   * @param updateTime updateTime or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3Environment setUpdateTime(String updateTime) {
    this.updateTime = updateTime;
    return this;
  }

  /**
   * A list of configurations for flow versions. You should include version configs for all flows
   * that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
   * @return value or {@code null} for none
   */
  public java.util.List getVersionConfigs() {
    return versionConfigs;
  }

  /**
   * A list of configurations for flow versions. You should include version configs for all flows
   * that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
   * @param versionConfigs versionConfigs or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3Environment setVersionConfigs(java.util.List versionConfigs) {
    this.versionConfigs = versionConfigs;
    return this;
  }

  /**
   * The webhook configuration for this environment.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3EnvironmentWebhookConfig getWebhookConfig() {
    return webhookConfig;
  }

  /**
   * The webhook configuration for this environment.
   * @param webhookConfig webhookConfig or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3Environment setWebhookConfig(GoogleCloudDialogflowCxV3EnvironmentWebhookConfig webhookConfig) {
    this.webhookConfig = webhookConfig;
    return this;
  }

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

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

}