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:

  • 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

      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()
       Optional. User-provided prefix for Cloud Storage filename. See the [object
 naming requirements](https://cloud.google.com/storage/docs/objects#naming).
      string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilenamePrefix in interface CloudStorageConfigOrBuilder
      Returns:
      The filenamePrefix.

    • getFilenamePrefixBytes

      public com.google.protobuf.ByteString getFilenamePrefixBytes()
       Optional. User-provided prefix for Cloud Storage filename. See the [object
 naming requirements](https://cloud.google.com/storage/docs/objects#naming).
      string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilenamePrefixBytes in interface CloudStorageConfigOrBuilder
      Returns:
      The bytes for filenamePrefix.

    • getFilenameSuffix

      public String getFilenameSuffix()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilenameSuffix in interface CloudStorageConfigOrBuilder
      Returns:
      The filenameSuffix.

    • getFilenameSuffixBytes

      public com.google.protobuf.ByteString getFilenameSuffixBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilenameSuffixBytes in interface CloudStorageConfigOrBuilder
      Returns:
      The bytes for filenameSuffix.

    • hasTextConfig

      public boolean hasTextConfig()
       Optional. If set, message data will be written to Cloud Storage in text
 format.
      .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTextConfig in interface CloudStorageConfigOrBuilder
      Returns:
      Whether the textConfig field is set.

    • getTextConfig

      public CloudStorageConfig.TextConfig getTextConfig()
       Optional. If set, message data will be written to Cloud Storage in text
 format.
      .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextConfig in interface CloudStorageConfigOrBuilder
      Returns:
      The textConfig.

    • getTextConfigOrBuilder

      public CloudStorageConfig.TextConfigOrBuilder getTextConfigOrBuilder()
       Optional. If set, message data will be written to Cloud Storage in text
 format.
      .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextConfigOrBuilder in interface CloudStorageConfigOrBuilder

    • hasAvroConfig

      public boolean hasAvroConfig()
       Optional. If set, message data will be written to Cloud Storage in Avro
 format.
      .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAvroConfig in interface CloudStorageConfigOrBuilder
      Returns:
      Whether the avroConfig field is set.

    • getAvroConfig

      public CloudStorageConfig.AvroConfig getAvroConfig()
       Optional. If set, message data will be written to Cloud Storage in Avro
 format.
      .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAvroConfig in interface CloudStorageConfigOrBuilder
      Returns:
      The avroConfig.

    • getAvroConfigOrBuilder

      public CloudStorageConfig.AvroConfigOrBuilder getAvroConfigOrBuilder()
       Optional. If set, message data will be written to Cloud Storage in Avro
 format.
      .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAvroConfigOrBuilder in interface CloudStorageConfigOrBuilder

    • hasMaxDuration

      public boolean hasMaxDuration()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasMaxDuration in interface CloudStorageConfigOrBuilder
      Returns:
      Whether the maxDuration field is set.

    • getMaxDuration

      public com.google.protobuf.Duration getMaxDuration()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMaxDuration in interface CloudStorageConfigOrBuilder
      Returns:
      The maxDuration.

    • getMaxDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxDurationOrBuilder()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMaxDurationOrBuilder in interface CloudStorageConfigOrBuilder

    • getMaxBytes

      public long getMaxBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      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