File "CloudStorageConfig.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/Pubsub/CloudStorageConfig.php
File size: 9.38 KB
MIME-type: text/x-php
Charset: utf-8
<?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 CloudStorageConfig extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The subscription can actively send messages to Cloud Storage.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Cannot write to the Cloud Storage bucket because of permission denied
* errors.
*/
public const STATE_PERMISSION_DENIED = 'PERMISSION_DENIED';
/**
* Cannot write to the Cloud Storage bucket because it does not exist.
*/
public const STATE_NOT_FOUND = 'NOT_FOUND';
/**
* Cannot write to the destination because enforce_in_transit is set to true
* and the destination locations are not in the allowed regions.
*/
public const STATE_IN_TRANSIT_LOCATION_RESTRICTION = 'IN_TRANSIT_LOCATION_RESTRICTION';
/**
* Cannot write to the Cloud Storage bucket due to an incompatibility between
* the topic schema and subscription settings.
*/
public const STATE_SCHEMA_MISMATCH = 'SCHEMA_MISMATCH';
protected $avroConfigType = AvroConfig::class;
protected $avroConfigDataType = '';
/**
* Required. User-provided name for the Cloud Storage bucket. The bucket must
* be created by the user. The bucket name must be without any prefix like
* "gs://". See the [bucket naming requirements]
* (https://cloud.google.com/storage/docs/buckets#naming).
*
* @var string
*/
public $bucket;
/**
* Optional. User-provided format string specifying how to represent datetimes
* in Cloud Storage filenames. See the [datetime format
* guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-
* subscription#file_names).
*
* @var string
*/
public $filenameDatetimeFormat;
/**
* Optional. User-provided prefix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
*
* @var string
*/
public $filenamePrefix;
/**
* Optional. User-provided suffix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
* Must not end in "/".
*
* @var string
*/
public $filenameSuffix;
/**
* Optional. The maximum bytes that can be written to a Cloud Storage file
* before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
* be exceeded in cases where messages are larger than the limit.
*
* @var string
*/
public $maxBytes;
/**
* Optional. The maximum duration that can elapse before a new Cloud Storage
* file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
* exceed the subscription's acknowledgment deadline.
*
* @var string
*/
public $maxDuration;
/**
* Optional. The maximum number of messages that can be written to a Cloud
* Storage file before a new file is created. Min 1000 messages.
*
* @var string
*/
public $maxMessages;
/**
* Optional. The service account to use to write to Cloud Storage. The
* subscription creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @var string
*/
public $serviceAccountEmail;
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* @var string
*/
public $state;
protected $textConfigType = TextConfig::class;
protected $textConfigDataType = '';
/**
* Optional. If set, message data will be written to Cloud Storage in Avro
* format.
*
* @param AvroConfig $avroConfig
*/
public function setAvroConfig(AvroConfig $avroConfig)
{
$this->avroConfig = $avroConfig;
}
/**
* @return AvroConfig
*/
public function getAvroConfig()
{
return $this->avroConfig;
}
/**
* Required. User-provided name for the Cloud Storage bucket. The bucket must
* be created by the user. The bucket name must be without any prefix like
* "gs://". See the [bucket naming requirements]
* (https://cloud.google.com/storage/docs/buckets#naming).
*
* @param string $bucket
*/
public function setBucket($bucket)
{
$this->bucket = $bucket;
}
/**
* @return string
*/
public function getBucket()
{
return $this->bucket;
}
/**
* Optional. User-provided format string specifying how to represent datetimes
* in Cloud Storage filenames. See the [datetime format
* guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-
* subscription#file_names).
*
* @param string $filenameDatetimeFormat
*/
public function setFilenameDatetimeFormat($filenameDatetimeFormat)
{
$this->filenameDatetimeFormat = $filenameDatetimeFormat;
}
/**
* @return string
*/
public function getFilenameDatetimeFormat()
{
return $this->filenameDatetimeFormat;
}
/**
* Optional. User-provided prefix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
*
* @param string $filenamePrefix
*/
public function setFilenamePrefix($filenamePrefix)
{
$this->filenamePrefix = $filenamePrefix;
}
/**
* @return string
*/
public function getFilenamePrefix()
{
return $this->filenamePrefix;
}
/**
* Optional. User-provided suffix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
* Must not end in "/".
*
* @param string $filenameSuffix
*/
public function setFilenameSuffix($filenameSuffix)
{
$this->filenameSuffix = $filenameSuffix;
}
/**
* @return string
*/
public function getFilenameSuffix()
{
return $this->filenameSuffix;
}
/**
* Optional. The maximum bytes that can be written to a Cloud Storage file
* before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
* be exceeded in cases where messages are larger than the limit.
*
* @param string $maxBytes
*/
public function setMaxBytes($maxBytes)
{
$this->maxBytes = $maxBytes;
}
/**
* @return string
*/
public function getMaxBytes()
{
return $this->maxBytes;
}
/**
* Optional. The maximum duration that can elapse before a new Cloud Storage
* file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
* exceed the subscription's acknowledgment deadline.
*
* @param string $maxDuration
*/
public function setMaxDuration($maxDuration)
{
$this->maxDuration = $maxDuration;
}
/**
* @return string
*/
public function getMaxDuration()
{
return $this->maxDuration;
}
/**
* Optional. The maximum number of messages that can be written to a Cloud
* Storage file before a new file is created. Min 1000 messages.
*
* @param string $maxMessages
*/
public function setMaxMessages($maxMessages)
{
$this->maxMessages = $maxMessages;
}
/**
* @return string
*/
public function getMaxMessages()
{
return $this->maxMessages;
}
/**
* Optional. The service account to use to write to Cloud Storage. The
* subscription creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @param string $serviceAccountEmail
*/
public function setServiceAccountEmail($serviceAccountEmail)
{
$this->serviceAccountEmail = $serviceAccountEmail;
}
/**
* @return string
*/
public function getServiceAccountEmail()
{
return $this->serviceAccountEmail;
}
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, PERMISSION_DENIED, NOT_FOUND,
* IN_TRANSIT_LOCATION_RESTRICTION, SCHEMA_MISMATCH
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. If set, message data will be written to Cloud Storage in text
* format.
*
* @param TextConfig $textConfig
*/
public function setTextConfig(TextConfig $textConfig)
{
$this->textConfig = $textConfig;
}
/**
* @return TextConfig
*/
public function getTextConfig()
{
return $this->textConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CloudStorageConfig::class, 'Google_Service_Pubsub_CloudStorageConfig');