Interface CloudStorageConfigOrBuilder (1.132.0) 

public interface CloudStorageConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAvroConfig()

public abstract CloudStorageConfig.AvroConfig getAvroConfig()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudStorageConfig.AvroConfig

The avroConfig.

getAvroConfigOrBuilder()

public abstract CloudStorageConfig.AvroConfigOrBuilder getAvroConfigOrBuilder()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudStorageConfig.AvroConfigOrBuilder

getBucket()

public abstract String getBucket()

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.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The bucket.

getBucketBytes()

public abstract ByteString getBucketBytes()

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.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for bucket.

getFilenameDatetimeFormat()

public abstract String getFilenameDatetimeFormat()

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

string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filenameDatetimeFormat.

getFilenameDatetimeFormatBytes()

public abstract ByteString getFilenameDatetimeFormatBytes()

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

string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filenameDatetimeFormat.

getFilenamePrefix()

public abstract String getFilenamePrefix()

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

string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filenamePrefix.

getFilenamePrefixBytes()

public abstract ByteString getFilenamePrefixBytes()

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

string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filenamePrefix.

getFilenameSuffix()

public abstract String getFilenameSuffix()

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

string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filenameSuffix.

getFilenameSuffixBytes()

public abstract ByteString getFilenameSuffixBytes()

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

string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filenameSuffix.

getMaxBytes()

public abstract long getMaxBytes()

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.

int64 max_bytes = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The maxBytes.

getMaxDuration()

public abstract Duration getMaxDuration()

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.

.google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The maxDuration.

getMaxDurationOrBuilder()

public abstract DurationOrBuilder getMaxDurationOrBuilder()

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.

.google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getMaxMessages()

public abstract long getMaxMessages()

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

int64 max_messages = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The maxMessages.

getOutputFormatCase()

public abstract CloudStorageConfig.OutputFormatCase getOutputFormatCase()
Returns
Type Description
CloudStorageConfig.OutputFormatCase

getServiceAccountEmail()

public abstract String getServiceAccountEmail()

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.

string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public abstract ByteString getServiceAccountEmailBytes()

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.

string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

getState()

public abstract CloudStorageConfig.State getState()

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

.google.pubsub.v1.CloudStorageConfig.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CloudStorageConfig.State

The state.

getStateValue()

public abstract int getStateValue()

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

.google.pubsub.v1.CloudStorageConfig.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTextConfig()

public abstract CloudStorageConfig.TextConfig getTextConfig()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudStorageConfig.TextConfig

The textConfig.

getTextConfigOrBuilder()

public abstract CloudStorageConfig.TextConfigOrBuilder getTextConfigOrBuilder()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudStorageConfig.TextConfigOrBuilder

hasAvroConfig()

public abstract boolean hasAvroConfig()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the avroConfig field is set.

hasMaxDuration()

public abstract boolean hasMaxDuration()

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.

.google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxDuration field is set.

hasTextConfig()

public abstract boolean hasTextConfig()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the textConfig field is set.