com.google.api.services.pubsub.model.CloudStorage Maven / Gradle / Ivy

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

/**
 * Ingestion settings for Cloud Storage.
 *
 *  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 Cloud Pub/Sub 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 CloudStorage extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Data from Cloud Storage will be interpreted in Avro format.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private AvroFormat avroFormat;

  /**
   * Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See
   * the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String bucket;

  /**
   * Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will
   * be ingested. See the [supported
   * patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-
   * prefixes-using-glob).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String matchGlob;

  /**
   * Optional. Only objects with a larger or equal creation timestamp will be ingested.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String minimumObjectCreateTime;

  /**
   * Optional. It will be assumed data from Cloud Storage was written via [Cloud Storage
   * subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private PubSubAvroFormat pubsubAvroFormat;

  /**
   * Output only. An output-only field that indicates the state of the Cloud Storage ingestion
   * source.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * Optional. Data from Cloud Storage will be interpreted as text.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TextFormat textFormat;

  /**
   * Optional. Data from Cloud Storage will be interpreted in Avro format.
   * @return value or {@code null} for none
   */
  public AvroFormat getAvroFormat() {
    return avroFormat;
  }

  /**
   * Optional. Data from Cloud Storage will be interpreted in Avro format.
   * @param avroFormat avroFormat or {@code null} for none
   */
  public CloudStorage setAvroFormat(AvroFormat avroFormat) {
    this.avroFormat = avroFormat;
    return this;
  }

  /**
   * Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See
   * the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
   * @return value or {@code null} for none
   */
  public java.lang.String getBucket() {
    return bucket;
  }

  /**
   * Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See
   * the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
   * @param bucket bucket or {@code null} for none
   */
  public CloudStorage setBucket(java.lang.String bucket) {
    this.bucket = bucket;
    return this;
  }

  /**
   * Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will
   * be ingested. See the [supported
   * patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-
   * prefixes-using-glob).
   * @return value or {@code null} for none
   */
  public java.lang.String getMatchGlob() {
    return matchGlob;
  }

  /**
   * Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will
   * be ingested. See the [supported
   * patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-
   * prefixes-using-glob).
   * @param matchGlob matchGlob or {@code null} for none
   */
  public CloudStorage setMatchGlob(java.lang.String matchGlob) {
    this.matchGlob = matchGlob;
    return this;
  }

  /**
   * Optional. Only objects with a larger or equal creation timestamp will be ingested.
   * @return value or {@code null} for none
   */
  public String getMinimumObjectCreateTime() {
    return minimumObjectCreateTime;
  }

  /**
   * Optional. Only objects with a larger or equal creation timestamp will be ingested.
   * @param minimumObjectCreateTime minimumObjectCreateTime or {@code null} for none
   */
  public CloudStorage setMinimumObjectCreateTime(String minimumObjectCreateTime) {
    this.minimumObjectCreateTime = minimumObjectCreateTime;
    return this;
  }

  /**
   * Optional. It will be assumed data from Cloud Storage was written via [Cloud Storage
   * subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
   * @return value or {@code null} for none
   */
  public PubSubAvroFormat getPubsubAvroFormat() {
    return pubsubAvroFormat;
  }

  /**
   * Optional. It will be assumed data from Cloud Storage was written via [Cloud Storage
   * subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
   * @param pubsubAvroFormat pubsubAvroFormat or {@code null} for none
   */
  public CloudStorage setPubsubAvroFormat(PubSubAvroFormat pubsubAvroFormat) {
    this.pubsubAvroFormat = pubsubAvroFormat;
    return this;
  }

  /**
   * Output only. An output-only field that indicates the state of the Cloud Storage ingestion
   * source.
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * Output only. An output-only field that indicates the state of the Cloud Storage ingestion
   * source.
   * @param state state or {@code null} for none
   */
  public CloudStorage setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  /**
   * Optional. Data from Cloud Storage will be interpreted as text.
   * @return value or {@code null} for none
   */
  public TextFormat getTextFormat() {
    return textFormat;
  }

  /**
   * Optional. Data from Cloud Storage will be interpreted as text.
   * @param textFormat textFormat or {@code null} for none
   */
  public CloudStorage setTextFormat(TextFormat textFormat) {
    this.textFormat = textFormat;
    return this;
  }

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

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

}