com.google.pubsub.v1

Class CloudStorageConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.CloudStorageConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CloudStorageConfigOrBuilder, Serializable

public final class CloudStorageConfig
extends com.google.protobuf.GeneratedMessageV3
implements CloudStorageConfigOrBuilder

 Configuration for a Cloud Storage subscription.
 

Protobuf type google.pubsub.v1.CloudStorageConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudStorageConfig.AvroConfig Configuration for writing message data in Avro format.
static interface	CloudStorageConfig.AvroConfigOrBuilder
static class	CloudStorageConfig.Builder Configuration for a Cloud Storage subscription.
static class	CloudStorageConfig.OutputFormatCase
static class	CloudStorageConfig.State Possible states for a Cloud Storage subscription.
static class	CloudStorageConfig.TextConfig Configuration for writing message data in text format.
static interface	CloudStorageConfig.TextConfigOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AVRO_CONFIG_FIELD_NUMBER
static int	BUCKET_FIELD_NUMBER
static int	FILENAME_PREFIX_FIELD_NUMBER
static int	FILENAME_SUFFIX_FIELD_NUMBER
static int	MAX_BYTES_FIELD_NUMBER
static int	MAX_DURATION_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	TEXT_CONFIG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CloudStorageConfig.AvroConfig	getAvroConfig() If set, message data will be written to Cloud Storage in Avro format.
CloudStorageConfig.AvroConfigOrBuilder	getAvroConfigOrBuilder() If set, message data will be written to Cloud Storage in Avro format.
String	getBucket() Required.
com.google.protobuf.ByteString	getBucketBytes() Required.
static CloudStorageConfig	getDefaultInstance()
CloudStorageConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilenamePrefix() User-provided prefix for Cloud Storage filename.
com.google.protobuf.ByteString	getFilenamePrefixBytes() User-provided prefix for Cloud Storage filename.
String	getFilenameSuffix() User-provided suffix for Cloud Storage filename.
com.google.protobuf.ByteString	getFilenameSuffixBytes() User-provided suffix for Cloud Storage filename.
long	getMaxBytes() The maximum bytes that can be written to a Cloud Storage file before a new file is created.
com.google.protobuf.Duration	getMaxDuration() The maximum duration that can elapse before a new Cloud Storage file is created.
com.google.protobuf.DurationOrBuilder	getMaxDurationOrBuilder() The maximum duration that can elapse before a new Cloud Storage file is created.
CloudStorageConfig.OutputFormatCase	getOutputFormatCase()
com.google.protobuf.Parser<CloudStorageConfig>	getParserForType()
int	getSerializedSize()
CloudStorageConfig.State	getState() Output only.
int	getStateValue() Output only.
CloudStorageConfig.TextConfig	getTextConfig() If set, message data will be written to Cloud Storage in text format.
CloudStorageConfig.TextConfigOrBuilder	getTextConfigOrBuilder() If set, message data will be written to Cloud Storage in text format.
boolean	hasAvroConfig() If set, message data will be written to Cloud Storage in Avro format.
int	hashCode()
boolean	hasMaxDuration() The maximum duration that can elapse before a new Cloud Storage file is created.
boolean	hasTextConfig() If set, message data will be written to Cloud Storage in text format.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CloudStorageConfig.Builder	newBuilder()
static CloudStorageConfig.Builder	newBuilder(CloudStorageConfig prototype)
CloudStorageConfig.Builder	newBuilderForType()
protected CloudStorageConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CloudStorageConfig	parseDelimitedFrom(InputStream input)
static CloudStorageConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CloudStorageConfig	parseFrom(byte[] data)
static CloudStorageConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CloudStorageConfig	parseFrom(ByteBuffer data)
static CloudStorageConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CloudStorageConfig	parseFrom(com.google.protobuf.ByteString data)
static CloudStorageConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CloudStorageConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static CloudStorageConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CloudStorageConfig	parseFrom(InputStream input)
static CloudStorageConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CloudStorageConfig>	parser()
CloudStorageConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER

See Also:

Constant Field Values

FILENAME_PREFIX_FIELD_NUMBER

public static final int FILENAME_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

FILENAME_SUFFIX_FIELD_NUMBER

public static final int FILENAME_SUFFIX_FIELD_NUMBER

See Also:

Constant Field Values

TEXT_CONFIG_FIELD_NUMBER

public static final int TEXT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

AVRO_CONFIG_FIELD_NUMBER

public static final int AVRO_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

MAX_DURATION_FIELD_NUMBER

public static final int MAX_DURATION_FIELD_NUMBER

See Also:

Constant Field Values

MAX_BYTES_FIELD_NUMBER

public static final int MAX_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getOutputFormatCase

public CloudStorageConfig.OutputFormatCase getOutputFormatCase()

Specified by:

getOutputFormatCase in interface CloudStorageConfigOrBuilder

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] (https://cloud.google.com/storage/docs/buckets#naming).
 

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

Specified by:

getBucket in interface CloudStorageConfigOrBuilder

Returns:

The bucket.

getBucketBytes

public com.google.protobuf.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] (https://cloud.google.com/storage/docs/buckets#naming).
 

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

Specified by:

getBucketBytes in interface CloudStorageConfigOrBuilder

Returns:

The bytes for bucket.

getFilenamePrefix

public String getFilenamePrefix()

 User-provided prefix for Cloud Storage filename. See the [object naming
 requirements](https://cloud.google.com/storage/docs/objects#naming).
 

string filename_prefix = 2;

Specified by:

getFilenamePrefix in interface CloudStorageConfigOrBuilder

Returns:

The filenamePrefix.

getFilenamePrefixBytes

public com.google.protobuf.ByteString getFilenamePrefixBytes()

 User-provided prefix for Cloud Storage filename. See the [object naming
 requirements](https://cloud.google.com/storage/docs/objects#naming).
 

string filename_prefix = 2;

Specified by:

getFilenamePrefixBytes in interface CloudStorageConfigOrBuilder

Returns:

The bytes for filenamePrefix.

getFilenameSuffix

public String getFilenameSuffix()

 User-provided suffix for Cloud Storage filename. See the [object naming
 requirements](https://cloud.google.com/storage/docs/objects#naming). Must
 not end in "/".
 

string filename_suffix = 3;

Specified by:

getFilenameSuffix in interface CloudStorageConfigOrBuilder

Returns:

The filenameSuffix.

getFilenameSuffixBytes

public com.google.protobuf.ByteString getFilenameSuffixBytes()

 User-provided suffix for Cloud Storage filename. See the [object naming
 requirements](https://cloud.google.com/storage/docs/objects#naming). Must
 not end in "/".
 

string filename_suffix = 3;

Specified by:

getFilenameSuffixBytes in interface CloudStorageConfigOrBuilder

Returns:

The bytes for filenameSuffix.

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;

Specified by:

hasTextConfig in interface CloudStorageConfigOrBuilder

Returns:

Whether the textConfig field is set.

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;

Specified by:

getTextConfig in interface CloudStorageConfigOrBuilder

Returns:

The textConfig.

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;

Specified by:

getTextConfigOrBuilder in interface CloudStorageConfigOrBuilder

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;

Specified by:

hasAvroConfig in interface CloudStorageConfigOrBuilder

Returns:

Whether the avroConfig field is set.

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;

Specified by:

getAvroConfig in interface CloudStorageConfigOrBuilder

Returns:

The avroConfig.

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;

Specified by:

getAvroConfigOrBuilder in interface CloudStorageConfigOrBuilder

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;

Specified by:

hasMaxDuration in interface CloudStorageConfigOrBuilder

Returns:

Whether the maxDuration field is set.

getMaxDuration

public com.google.protobuf.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;

Specified by:

getMaxDuration in interface CloudStorageConfigOrBuilder

Returns:

The maxDuration.

getMaxDurationOrBuilder

public com.google.protobuf.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;

Specified by:

getMaxDurationOrBuilder in interface CloudStorageConfigOrBuilder

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;

Specified by:

getMaxBytes in interface CloudStorageConfigOrBuilder

Returns:

The maxBytes.

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

Specified by:

getStateValue in interface CloudStorageConfigOrBuilder

Returns:

The enum numeric value on the wire for state.

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

Specified by:

getState in interface CloudStorageConfigOrBuilder

Returns:

The state.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CloudStorageConfig parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CloudStorageConfig parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CloudStorageConfig parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CloudStorageConfig parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CloudStorageConfig parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CloudStorageConfig parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CloudStorageConfig parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static CloudStorageConfig parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static CloudStorageConfig parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static CloudStorageConfig parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static CloudStorageConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static CloudStorageConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public CloudStorageConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CloudStorageConfig.Builder newBuilder()

newBuilder

public static CloudStorageConfig.Builder newBuilder(CloudStorageConfig prototype)

toBuilder

public CloudStorageConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CloudStorageConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CloudStorageConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<CloudStorageConfig> parser()

getParserForType

public com.google.protobuf.Parser<CloudStorageConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CloudStorageConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder