com.google.api.services.pubsub.model.MessageStoragePolicy 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-rev20241212-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;

/**
 * A policy constraining the storage of messages published to the topic.
 *
 *  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 MessageStoragePolicy extends com.google.api.client.json.GenericJson {

  /**
   * Optional. A list of IDs of Google Cloud regions where messages that are published to the topic
   * may be persisted in storage. Messages published by publishers running in non-allowed Google
   * Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of
   * the allowed regions. An empty list means that no regions are allowed, and is not a valid
   * configuration.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List allowedPersistenceRegions;

  /**
   * Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees
   * for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe
   * operations on any subscription attached to this topic in any region that is not in
   * `allowed_persistence_regions`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean enforceInTransit;

  /**
   * Optional. A list of IDs of Google Cloud regions where messages that are published to the topic
   * may be persisted in storage. Messages published by publishers running in non-allowed Google
   * Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of
   * the allowed regions. An empty list means that no regions are allowed, and is not a valid
   * configuration.
   * @return value or {@code null} for none
   */
  public java.util.List getAllowedPersistenceRegions() {
    return allowedPersistenceRegions;
  }

  /**
   * Optional. A list of IDs of Google Cloud regions where messages that are published to the topic
   * may be persisted in storage. Messages published by publishers running in non-allowed Google
   * Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of
   * the allowed regions. An empty list means that no regions are allowed, and is not a valid
   * configuration.
   * @param allowedPersistenceRegions allowedPersistenceRegions or {@code null} for none
   */
  public MessageStoragePolicy setAllowedPersistenceRegions(java.util.List allowedPersistenceRegions) {
    this.allowedPersistenceRegions = allowedPersistenceRegions;
    return this;
  }

  /**
   * Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees
   * for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe
   * operations on any subscription attached to this topic in any region that is not in
   * `allowed_persistence_regions`.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getEnforceInTransit() {
    return enforceInTransit;
  }

  /**
   * Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees
   * for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe
   * operations on any subscription attached to this topic in any region that is not in
   * `allowed_persistence_regions`.
   * @param enforceInTransit enforceInTransit or {@code null} for none
   */
  public MessageStoragePolicy setEnforceInTransit(java.lang.Boolean enforceInTransit) {
    this.enforceInTransit = enforceInTransit;
    return this;
  }

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

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

}