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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-contactcenterinsights Show documentation
There is a newer version: v1-rev20240701-2.0.0
Show 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.contactcenterinsights.v1.model;

/**
 * Configuration for Cloud Storage bucket sources.
 *
 *  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 GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Specifies the type of the objects in `bucket_uri`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String bucketObjectType;

  /**
   * Required. The Cloud Storage bucket containing source objects.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String bucketUri;

  /**
   * Optional. Custom keys to extract as conversation labels from metadata files in
   * `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a
   * limit of 20 labels per conversation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List customMetadataKeys;

  /**
   * Optional. The Cloud Storage path to the source object metadata. Note that: [1] metadata files
   * are expected to be in JSON format [2] metadata and source objects must be in separate buckets
   * [3] a source object's metadata object must share the same name to be properly ingested
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String metadataBucketUri;

  /**
   * Optional. Specifies the type of the objects in `bucket_uri`.
   * @return value or {@code null} for none
   */
  public java.lang.String getBucketObjectType() {
    return bucketObjectType;
  }

  /**
   * Optional. Specifies the type of the objects in `bucket_uri`.
   * @param bucketObjectType bucketObjectType or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource setBucketObjectType(java.lang.String bucketObjectType) {
    this.bucketObjectType = bucketObjectType;
    return this;
  }

  /**
   * Required. The Cloud Storage bucket containing source objects.
   * @return value or {@code null} for none
   */
  public java.lang.String getBucketUri() {
    return bucketUri;
  }

  /**
   * Required. The Cloud Storage bucket containing source objects.
   * @param bucketUri bucketUri or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource setBucketUri(java.lang.String bucketUri) {
    this.bucketUri = bucketUri;
    return this;
  }

  /**
   * Optional. Custom keys to extract as conversation labels from metadata files in
   * `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a
   * limit of 20 labels per conversation.
   * @return value or {@code null} for none
   */
  public java.util.List getCustomMetadataKeys() {
    return customMetadataKeys;
  }

  /**
   * Optional. Custom keys to extract as conversation labels from metadata files in
   * `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a
   * limit of 20 labels per conversation.
   * @param customMetadataKeys customMetadataKeys or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource setCustomMetadataKeys(java.util.List customMetadataKeys) {
    this.customMetadataKeys = customMetadataKeys;
    return this;
  }

  /**
   * Optional. The Cloud Storage path to the source object metadata. Note that: [1] metadata files
   * are expected to be in JSON format [2] metadata and source objects must be in separate buckets
   * [3] a source object's metadata object must share the same name to be properly ingested
   * @return value or {@code null} for none
   */
  public java.lang.String getMetadataBucketUri() {
    return metadataBucketUri;
  }

  /**
   * Optional. The Cloud Storage path to the source object metadata. Note that: [1] metadata files
   * are expected to be in JSON format [2] metadata and source objects must be in separate buckets
   * [3] a source object's metadata object must share the same name to be properly ingested
   * @param metadataBucketUri metadataBucketUri or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource setMetadataBucketUri(java.lang.String metadataBucketUri) {
    this.metadataBucketUri = metadataBucketUri;
    return this;
  }

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

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

}