Cloud Pub/Sub v1 API - Class CloudStorageConfig (3.12.0)

public sealed class CloudStorageConfig : IMessage<CloudStorageConfig>, IEquatable<CloudStorageConfig>, IDeepCloneable<CloudStorageConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class CloudStorageConfig.

Configuration for a Cloud Storage subscription.

Inheritance

object > CloudStorageConfig

Implements

IMessage CloudStorageConfig, IEquatable CloudStorageConfig, IDeepCloneable CloudStorageConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

CloudStorageConfig()

public CloudStorageConfig()

CloudStorageConfig(CloudStorageConfig)

public CloudStorageConfig(CloudStorageConfig other)

Parameter
Name	Description
`other`	`CloudStorageConfig`

Properties

AvroConfig

public CloudStorageConfig.Types.AvroConfig AvroConfig { get; set; }

Optional. If set, message data will be written to Cloud Storage in Avro format.

Property Value
Type	Description
`CloudStorageConfigTypesAvroConfig`

Bucket

public string Bucket { get; set; }

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.

Property Value
Type	Description
`string`

FilenameDatetimeFormat

public string FilenameDatetimeFormat { get; set; }

Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.

Property Value
Type	Description
`string`

FilenamePrefix

public string FilenamePrefix { get; set; }

Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.

Property Value
Type	Description
`string`

FilenameSuffix

public string FilenameSuffix { get; set; }

Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".

Property Value
Type	Description
`string`

MaxBytes

public long MaxBytes { get; set; }

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.

Property Value
Type	Description
`long`

MaxDuration

public Duration MaxDuration { get; set; }

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 acknowledgement deadline.

Property Value
Type	Description
`Duration`

OutputFormatCase

public CloudStorageConfig.OutputFormatOneofCase OutputFormatCase { get; }

Property Value
Type	Description
`CloudStorageConfigOutputFormatOneofCase`

State

public CloudStorageConfig.Types.State State { get; set; }

Output only. An output-only field that indicates whether or not the subscription can receive messages.

Property Value
Type	Description
`CloudStorageConfigTypesState`

TextConfig

public CloudStorageConfig.Types.TextConfig TextConfig { get; set; }

Optional. If set, message data will be written to Cloud Storage in text format.

Property Value
Type	Description
`CloudStorageConfigTypesTextConfig`