public static final class CloudStorageConfig.AvroConfig extends GeneratedMessage implements CloudStorageConfig.AvroConfigOrBuilderConfiguration 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > CloudStorageConfig.AvroConfigImplements
CloudStorageConfig.AvroConfigOrBuilderStatic Fields
USE_TOPIC_SCHEMA_FIELD_NUMBER
public static final int USE_TOPIC_SCHEMA_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WRITE_METADATA_FIELD_NUMBER
public static final int WRITE_METADATA_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static CloudStorageConfig.AvroConfig getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static CloudStorageConfig.AvroConfig.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig.Builder |
|
newBuilder(CloudStorageConfig.AvroConfig prototype)
public static CloudStorageConfig.AvroConfig.Builder newBuilder(CloudStorageConfig.AvroConfig prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
CloudStorageConfig.AvroConfig |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig.Builder |
|
parseDelimitedFrom(InputStream input)
public static CloudStorageConfig.AvroConfig parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig.AvroConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static CloudStorageConfig.AvroConfig parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig.AvroConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static CloudStorageConfig.AvroConfig parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig.AvroConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static CloudStorageConfig.AvroConfig parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig.AvroConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static CloudStorageConfig.AvroConfig parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig.AvroConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static CloudStorageConfig.AvroConfig parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig.AvroConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<CloudStorageConfig.AvroConfig> parser()| Returns | |
|---|---|
| Type | Description |
Parser<AvroConfig> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public CloudStorageConfig.AvroConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
|
getParserForType()
public Parser<CloudStorageConfig.AvroConfig> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<AvroConfig> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public CloudStorageConfig.AvroConfig.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected CloudStorageConfig.AvroConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig.Builder |
|
toBuilder()
public CloudStorageConfig.AvroConfig.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|