Package com.google.pubsub.v1

Class 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

    • 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

      • 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.

      • 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.

      • 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​(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

      • 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

      • 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