📂 File Browser

📁 Directories

📄 Files

📄 Source: MessageStoragePolicy.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * 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.
 */

namespace Google\Service\Pubsub;

class MessageStoragePolicy extends \Google\Collection
{
  protected $collection_key = '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.
   *
   * @var string[]
   */
  public $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`.
   *
   * @var bool
   */
  public $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.
   *
   * @param string[] $allowedPersistenceRegions
   */
  public function setAllowedPersistenceRegions($allowedPersistenceRegions)
  {
    $this->allowedPersistenceRegions = $allowedPersistenceRegions;
  }
  /**
   * @return string[]
   */
  public function getAllowedPersistenceRegions()
  {
    return $this->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`.
   *
   * @param bool $enforceInTransit
   */
  public function setEnforceInTransit($enforceInTransit)
  {
    $this->enforceInTransit = $enforceInTransit;
  }
  /**
   * @return bool
   */
  public function getEnforceInTransit()
  {
    return $this->enforceInTransit;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MessageStoragePolicy::class, 'Google_Service_Pubsub_MessageStoragePolicy');