Class CloudStorageConfig.Builder (1.123.18)

public static final class CloudStorageConfig.Builder extends GeneratedMessageV3.Builder<CloudStorageConfig.Builder> implements CloudStorageConfigOrBuilder

Configuration for a Cloud Storage subscription.

Protobuf type google.pubsub.v1.CloudStorageConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CloudStorageConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

build()

public CloudStorageConfig build()
Returns
TypeDescription
CloudStorageConfig

buildPartial()

public CloudStorageConfig buildPartial()
Returns
TypeDescription
CloudStorageConfig

clear()

public CloudStorageConfig.Builder clear()
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

clearAvroConfig()

public CloudStorageConfig.Builder clearAvroConfig()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Returns
TypeDescription
CloudStorageConfig.Builder

clearBucket()

public CloudStorageConfig.Builder clearBucket()

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
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CloudStorageConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

clearFilenamePrefix()

public CloudStorageConfig.Builder clearFilenamePrefix()

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

string filename_prefix = 2;

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

clearFilenameSuffix()

public CloudStorageConfig.Builder clearFilenameSuffix()

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

string filename_suffix = 3;

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

clearMaxBytes()

public CloudStorageConfig.Builder clearMaxBytes()

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;

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

clearMaxDuration()

public CloudStorageConfig.Builder clearMaxDuration()

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;

Returns
TypeDescription
CloudStorageConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public CloudStorageConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

clearOutputFormat()

public CloudStorageConfig.Builder clearOutputFormat()
Returns
TypeDescription
CloudStorageConfig.Builder

clearState()

public CloudStorageConfig.Builder clearState()

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
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

clearTextConfig()

public CloudStorageConfig.Builder clearTextConfig()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Returns
TypeDescription
CloudStorageConfig.Builder

clone()

public CloudStorageConfig.Builder clone()
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

getAvroConfig()

public CloudStorageConfig.AvroConfig getAvroConfig()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Returns
TypeDescription
CloudStorageConfig.AvroConfig

The avroConfig.

getAvroConfigBuilder()

public CloudStorageConfig.AvroConfig.Builder getAvroConfigBuilder()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Returns
TypeDescription
CloudStorageConfig.AvroConfig.Builder

getAvroConfigOrBuilder()

public CloudStorageConfig.AvroConfigOrBuilder getAvroConfigOrBuilder()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Returns
TypeDescription
CloudStorageConfig.AvroConfigOrBuilder

getBucket()

public 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
TypeDescription
String

The bucket.

getBucketBytes()

public 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
TypeDescription
ByteString

The bytes for bucket.

getDefaultInstanceForType()

public CloudStorageConfig getDefaultInstanceForType()
Returns
TypeDescription
CloudStorageConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilenamePrefix()

public String getFilenamePrefix()

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

string filename_prefix = 2;

Returns
TypeDescription
String

The filenamePrefix.

getFilenamePrefixBytes()

public ByteString getFilenamePrefixBytes()

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

string filename_prefix = 2;

Returns
TypeDescription
ByteString

The bytes for filenamePrefix.

getFilenameSuffix()

public String getFilenameSuffix()

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

string filename_suffix = 3;

Returns
TypeDescription
String

The filenameSuffix.

getFilenameSuffixBytes()

public ByteString getFilenameSuffixBytes()

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

string filename_suffix = 3;

Returns
TypeDescription
ByteString

The bytes for filenameSuffix.

getMaxBytes()

public long getMaxBytes()

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;

Returns
TypeDescription
long

The maxBytes.

getMaxDuration()

public Duration getMaxDuration()

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;

Returns
TypeDescription
Duration

The maxDuration.

getMaxDurationBuilder()

public Duration.Builder getMaxDurationBuilder()

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;

Returns
TypeDescription
Builder

getMaxDurationOrBuilder()

public DurationOrBuilder getMaxDurationOrBuilder()

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;

Returns
TypeDescription
DurationOrBuilder

getOutputFormatCase()

public CloudStorageConfig.OutputFormatCase getOutputFormatCase()
Returns
TypeDescription
CloudStorageConfig.OutputFormatCase

getState()

public 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
TypeDescription
CloudStorageConfig.State

The state.

getStateValue()

public 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
TypeDescription
int

The enum numeric value on the wire for state.

getTextConfig()

public CloudStorageConfig.TextConfig getTextConfig()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Returns
TypeDescription
CloudStorageConfig.TextConfig

The textConfig.

getTextConfigBuilder()

public CloudStorageConfig.TextConfig.Builder getTextConfigBuilder()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Returns
TypeDescription
CloudStorageConfig.TextConfig.Builder

getTextConfigOrBuilder()

public CloudStorageConfig.TextConfigOrBuilder getTextConfigOrBuilder()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Returns
TypeDescription
CloudStorageConfig.TextConfigOrBuilder

hasAvroConfig()

public boolean hasAvroConfig()

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Returns
TypeDescription
boolean

Whether the avroConfig field is set.

hasMaxDuration()

public boolean hasMaxDuration()

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;

Returns
TypeDescription
boolean

Whether the maxDuration field is set.

hasTextConfig()

public boolean hasTextConfig()

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Returns
TypeDescription
boolean

Whether the textConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAvroConfig(CloudStorageConfig.AvroConfig value)

public CloudStorageConfig.Builder mergeAvroConfig(CloudStorageConfig.AvroConfig value)

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Parameter
NameDescription
valueCloudStorageConfig.AvroConfig
Returns
TypeDescription
CloudStorageConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CloudStorageConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CloudStorageConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

mergeFrom(CloudStorageConfig other)

public CloudStorageConfig.Builder mergeFrom(CloudStorageConfig other)
Parameter
NameDescription
otherCloudStorageConfig
Returns
TypeDescription
CloudStorageConfig.Builder

mergeMaxDuration(Duration value)

public CloudStorageConfig.Builder mergeMaxDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
CloudStorageConfig.Builder

mergeTextConfig(CloudStorageConfig.TextConfig value)

public CloudStorageConfig.Builder mergeTextConfig(CloudStorageConfig.TextConfig value)

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Parameter
NameDescription
valueCloudStorageConfig.TextConfig
Returns
TypeDescription
CloudStorageConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CloudStorageConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

setAvroConfig(CloudStorageConfig.AvroConfig value)

public CloudStorageConfig.Builder setAvroConfig(CloudStorageConfig.AvroConfig value)

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Parameter
NameDescription
valueCloudStorageConfig.AvroConfig
Returns
TypeDescription
CloudStorageConfig.Builder

setAvroConfig(CloudStorageConfig.AvroConfig.Builder builderForValue)

public CloudStorageConfig.Builder setAvroConfig(CloudStorageConfig.AvroConfig.Builder builderForValue)

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

.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

Parameter
NameDescription
builderForValueCloudStorageConfig.AvroConfig.Builder
Returns
TypeDescription
CloudStorageConfig.Builder

setBucket(String value)

public CloudStorageConfig.Builder setBucket(String value)

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];

Parameter
NameDescription
valueString

The bucket to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setBucketBytes(ByteString value)

public CloudStorageConfig.Builder setBucketBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for bucket to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CloudStorageConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

setFilenamePrefix(String value)

public CloudStorageConfig.Builder setFilenamePrefix(String value)

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

string filename_prefix = 2;

Parameter
NameDescription
valueString

The filenamePrefix to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setFilenamePrefixBytes(ByteString value)

public CloudStorageConfig.Builder setFilenamePrefixBytes(ByteString value)

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

string filename_prefix = 2;

Parameter
NameDescription
valueByteString

The bytes for filenamePrefix to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setFilenameSuffix(String value)

public CloudStorageConfig.Builder setFilenameSuffix(String value)

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

string filename_suffix = 3;

Parameter
NameDescription
valueString

The filenameSuffix to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setFilenameSuffixBytes(ByteString value)

public CloudStorageConfig.Builder setFilenameSuffixBytes(ByteString value)

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

string filename_suffix = 3;

Parameter
NameDescription
valueByteString

The bytes for filenameSuffix to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setMaxBytes(long value)

public CloudStorageConfig.Builder setMaxBytes(long value)

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;

Parameter
NameDescription
valuelong

The maxBytes to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setMaxDuration(Duration value)

public CloudStorageConfig.Builder setMaxDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
CloudStorageConfig.Builder

setMaxDuration(Duration.Builder builderForValue)

public CloudStorageConfig.Builder setMaxDuration(Duration.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
CloudStorageConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CloudStorageConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides

setState(CloudStorageConfig.State value)

public CloudStorageConfig.Builder setState(CloudStorageConfig.State value)

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];

Parameter
NameDescription
valueCloudStorageConfig.State

The state to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setStateValue(int value)

public CloudStorageConfig.Builder setStateValue(int value)

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];

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
CloudStorageConfig.Builder

This builder for chaining.

setTextConfig(CloudStorageConfig.TextConfig value)

public CloudStorageConfig.Builder setTextConfig(CloudStorageConfig.TextConfig value)

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Parameter
NameDescription
valueCloudStorageConfig.TextConfig
Returns
TypeDescription
CloudStorageConfig.Builder

setTextConfig(CloudStorageConfig.TextConfig.Builder builderForValue)

public CloudStorageConfig.Builder setTextConfig(CloudStorageConfig.TextConfig.Builder builderForValue)

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

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Parameter
NameDescription
builderForValueCloudStorageConfig.TextConfig.Builder
Returns
TypeDescription
CloudStorageConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final CloudStorageConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CloudStorageConfig.Builder
Overrides