Class CloudStorageConfig

Configuration for a Cloud Storage subscription.

Inheritance

object

CloudStorageConfig

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Pubsub.v1.Data

Assembly: Google.Apis.Pubsub.v1.dll

Syntax

public class CloudStorageConfig : IDirectResponseSchema

Properties

AvroConfig

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

Declaration

[JsonProperty("avroConfig")]
public virtual AvroConfig AvroConfig { get; set; }

Property Value

Type	Description
AvroConfig

Bucket

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).

Declaration

[JsonProperty("bucket")]
public virtual string Bucket { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

FilenameDatetimeFormat

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

Declaration

[JsonProperty("filenameDatetimeFormat")]
public virtual string FilenameDatetimeFormat { get; set; }

Property Value

Type	Description
string

FilenamePrefix

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

Declaration

[JsonProperty("filenamePrefix")]
public virtual string FilenamePrefix { get; set; }

Property Value

Type	Description
string

FilenameSuffix

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

Declaration

[JsonProperty("filenameSuffix")]
public virtual string FilenameSuffix { get; set; }

Property Value

Type	Description
string

MaxBytes

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.

Declaration

[JsonProperty("maxBytes")]
public virtual long? MaxBytes { get; set; }

Property Value

Type	Description
long?

MaxDuration

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.

Declaration

[JsonProperty("maxDuration")]
public virtual object MaxDuration { get; set; }

Property Value

Type	Description
object

MaxMessages

Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.

Declaration

[JsonProperty("maxMessages")]
public virtual long? MaxMessages { get; set; }

Property Value

Type	Description
long?

ServiceAccountEmail

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, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

Declaration

[JsonProperty("serviceAccountEmail")]
public virtual string ServiceAccountEmail { get; set; }

Property Value

Type	Description
string

State

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

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

TextConfig

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

Declaration

[JsonProperty("textConfig")]
public virtual TextConfig TextConfig { get; set; }

Property Value

Type	Description
TextConfig

Implements

IDirectResponseSchema