Class CloudStorageConfig.AvroConfig.Builder (1.131.0)

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

Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.

Protobuf type google.pubsub.v1.CloudStorageConfig.AvroConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CloudStorageConfig.AvroConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

build()

public CloudStorageConfig.AvroConfig build()
Returns
Type Description
CloudStorageConfig.AvroConfig

buildPartial()

public CloudStorageConfig.AvroConfig buildPartial()
Returns
Type Description
CloudStorageConfig.AvroConfig

clear()

public CloudStorageConfig.AvroConfig.Builder clear()
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CloudStorageConfig.AvroConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CloudStorageConfig.AvroConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

clearUseTopicSchema()

public CloudStorageConfig.AvroConfig.Builder clearUseTopicSchema()

Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.

bool use_topic_schema = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudStorageConfig.AvroConfig.Builder

This builder for chaining.

clearWriteMetadata()

public CloudStorageConfig.AvroConfig.Builder clearWriteMetadata()

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudStorageConfig.AvroConfig.Builder

This builder for chaining.

clone()

public CloudStorageConfig.AvroConfig.Builder clone()
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

getDefaultInstanceForType()

public CloudStorageConfig.AvroConfig getDefaultInstanceForType()
Returns
Type Description
CloudStorageConfig.AvroConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getUseTopicSchema()

public boolean getUseTopicSchema()

Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.

bool use_topic_schema = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The useTopicSchema.

getWriteMetadata()

public boolean getWriteMetadata()

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The writeMetadata.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CloudStorageConfig.AvroConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CloudStorageConfig.AvroConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

mergeFrom(CloudStorageConfig.AvroConfig other)

public CloudStorageConfig.AvroConfig.Builder mergeFrom(CloudStorageConfig.AvroConfig other)
Parameter
Name Description
other CloudStorageConfig.AvroConfig
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CloudStorageConfig.AvroConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CloudStorageConfig.AvroConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

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

public CloudStorageConfig.AvroConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CloudStorageConfig.AvroConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CloudStorageConfig.AvroConfig.Builder
Overrides

setUseTopicSchema(boolean value)

public CloudStorageConfig.AvroConfig.Builder setUseTopicSchema(boolean value)

Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.

bool use_topic_schema = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The useTopicSchema to set.

Returns
Type Description
CloudStorageConfig.AvroConfig.Builder

This builder for chaining.

setWriteMetadata(boolean value)

public CloudStorageConfig.AvroConfig.Builder setWriteMetadata(boolean value)

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The writeMetadata to set.

Returns
Type Description
CloudStorageConfig.AvroConfig.Builder

This builder for chaining.