Class CloudStorageConfig.AvroConfig (1.127.3)

public static final class CloudStorageConfig.AvroConfig extends GeneratedMessageV3 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 Fields

WRITE_METADATA_FIELD_NUMBER

public static final int WRITE_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CloudStorageConfig.AvroConfig getDefaultInstance()
Returns
TypeDescription
CloudStorageConfig.AvroConfig

getDescriptor()

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

newBuilder()

public static CloudStorageConfig.AvroConfig.Builder newBuilder()
Returns
TypeDescription
CloudStorageConfig.AvroConfig.Builder

newBuilder(CloudStorageConfig.AvroConfig prototype)

public static CloudStorageConfig.AvroConfig.Builder newBuilder(CloudStorageConfig.AvroConfig prototype)
Parameter
NameDescription
prototypeCloudStorageConfig.AvroConfig
Returns
TypeDescription
CloudStorageConfig.AvroConfig.Builder

parseDelimitedFrom(InputStream input)

public static CloudStorageConfig.AvroConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig.AvroConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CloudStorageConfig.AvroConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig.AvroConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CloudStorageConfig.AvroConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig.AvroConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CloudStorageConfig.AvroConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig.AvroConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CloudStorageConfig.AvroConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig.AvroConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CloudStorageConfig.AvroConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig.AvroConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageConfig.AvroConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CloudStorageConfig.AvroConfig> parser()
Returns
TypeDescription
Parser<AvroConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CloudStorageConfig.AvroConfig getDefaultInstanceForType()
Returns
TypeDescription
CloudStorageConfig.AvroConfig

getParserForType()

public Parser<CloudStorageConfig.AvroConfig> getParserForType()
Returns
TypeDescription
Parser<AvroConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
boolean

The writeMetadata.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CloudStorageConfig.AvroConfig.Builder newBuilderForType()
Returns
TypeDescription
CloudStorageConfig.AvroConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CloudStorageConfig.AvroConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CloudStorageConfig.AvroConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CloudStorageConfig.AvroConfig.Builder toBuilder()
Returns
TypeDescription
CloudStorageConfig.AvroConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException