Package 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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Configuration for writing message data in Avro format.static interface
static final class
Configuration for a Cloud Storage subscription.static enum
static enum
Possible states for a Cloud Storage subscription.static final class
Configuration for writing message data in text format.static interface
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
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
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 TypeMethodDescriptionboolean
If set, message data will be written to Cloud Storage in Avro format.If set, message data will be written to Cloud Storage in Avro format.Required.com.google.protobuf.ByteString
Required.static CloudStorageConfig
static final com.google.protobuf.Descriptors.Descriptor
User-provided prefix for Cloud Storage filename.com.google.protobuf.ByteString
User-provided prefix for Cloud Storage filename.User-provided suffix for Cloud Storage filename.com.google.protobuf.ByteString
User-provided suffix for Cloud Storage filename.long
The maximum bytes that can be written to a Cloud Storage file before a new file is created.com.google.protobuf.Duration
The maximum duration that can elapse before a new Cloud Storage file is created.com.google.protobuf.DurationOrBuilder
The maximum duration that can elapse before a new Cloud Storage file is created.com.google.protobuf.Parser<CloudStorageConfig>
int
getState()
Output only.int
Output only.If set, message data will be written to Cloud Storage in text format.If set, message data will be written to Cloud Storage in text format.boolean
If set, message data will be written to Cloud Storage in Avro format.int
hashCode()
boolean
The maximum duration that can elapse before a new Cloud Storage file is created.boolean
If set, message data will be written to Cloud Storage in text format.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static CloudStorageConfig.Builder
static CloudStorageConfig.Builder
newBuilder
(CloudStorageConfig prototype) 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
(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 CloudStorageConfig
parseFrom
(ByteBuffer data) static CloudStorageConfig
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<CloudStorageConfig>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
BUCKET_FIELD_NUMBER
public static final int BUCKET_FIELD_NUMBER- See Also:
-
FILENAME_PREFIX_FIELD_NUMBER
public static final int FILENAME_PREFIX_FIELD_NUMBER- See Also:
-
FILENAME_SUFFIX_FIELD_NUMBER
public static final int FILENAME_SUFFIX_FIELD_NUMBER- See Also:
-
TEXT_CONFIG_FIELD_NUMBER
public static final int TEXT_CONFIG_FIELD_NUMBER- See Also:
-
AVRO_CONFIG_FIELD_NUMBER
public static final int AVRO_CONFIG_FIELD_NUMBER- See Also:
-
MAX_DURATION_FIELD_NUMBER
public static final int MAX_DURATION_FIELD_NUMBER- See Also:
-
MAX_BYTES_FIELD_NUMBER
public static final int MAX_BYTES_FIELD_NUMBER- See Also:
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
getOutputFormatCase
- Specified by:
getOutputFormatCase
in interfaceCloudStorageConfigOrBuilder
-
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 interfaceCloudStorageConfigOrBuilder
- 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 interfaceCloudStorageConfigOrBuilder
- Returns:
- The bytes for bucket.
-
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 interfaceCloudStorageConfigOrBuilder
- 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 interfaceCloudStorageConfigOrBuilder
- Returns:
- The bytes for filenamePrefix.
-
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 interfaceCloudStorageConfigOrBuilder
- 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 interfaceCloudStorageConfigOrBuilder
- 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 interfaceCloudStorageConfigOrBuilder
- Returns:
- Whether the textConfig field is set.
-
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 interfaceCloudStorageConfigOrBuilder
- Returns:
- The textConfig.
-
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 interfaceCloudStorageConfigOrBuilder
-
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 interfaceCloudStorageConfigOrBuilder
- Returns:
- Whether the avroConfig field is set.
-
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 interfaceCloudStorageConfigOrBuilder
- Returns:
- The avroConfig.
-
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 interfaceCloudStorageConfigOrBuilder
-
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 interfaceCloudStorageConfigOrBuilder
- 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 interfaceCloudStorageConfigOrBuilder
- 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 interfaceCloudStorageConfigOrBuilder
-
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 interfaceCloudStorageConfigOrBuilder
- 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 interfaceCloudStorageConfigOrBuilder
- Returns:
- The enum numeric value on the wire for 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 interfaceCloudStorageConfigOrBuilder
- Returns:
- The state.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static CloudStorageConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CloudStorageConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-