Packages

c

com.google.pubsub.v1

CloudStorageConfig

final class CloudStorageConfig extends GeneratedMessageV3 with CloudStorageConfigOrBuilder

Configuration for a Cloud Storage subscription.

Protobuf type google.pubsub.v1.CloudStorageConfig

Source
CloudStorageConfig.java
Linear Supertypes
CloudStorageConfigOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CloudStorageConfig
  2. CloudStorageConfigOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    CloudStorageConfig → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. def getAvroConfig(): AvroConfig

    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.

    .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

    returns

    The avroConfig.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  12. def getAvroConfigOrBuilder(): AvroConfigOrBuilder

    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.

    .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  13. def getBucket(): String

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


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

    returns

    The bucket.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  14. def getBucketBytes(): ByteString

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


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

    returns

    The bytes for bucket.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getDefaultInstanceForType(): CloudStorageConfig
    Definition Classes
    CloudStorageConfig → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  17. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  18. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  19. def getFilenamePrefix(): String

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


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

    string filename_prefix = 2;

    returns

    The filenamePrefix.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  20. def getFilenamePrefixBytes(): ByteString

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


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

    string filename_prefix = 2;

    returns

    The bytes for filenamePrefix.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  21. def getFilenameSuffix(): String

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


    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;

    returns

    The filenameSuffix.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  22. def getFilenameSuffixBytes(): ByteString

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


    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;

    returns

    The bytes for filenameSuffix.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  23. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  24. def getMaxBytes(): Long

    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.


    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;

    returns

    The maxBytes.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  25. def getMaxDuration(): Duration

    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.


    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;

    returns

    The maxDuration.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  26. def getMaxDurationOrBuilder(): DurationOrBuilder

    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.


    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;

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  27. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  28. def getOutputFormatCase(): OutputFormatCase
    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
  29. def getParserForType(): Parser[CloudStorageConfig]
    Definition Classes
    CloudStorageConfig → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  30. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  31. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  32. def getSerializedSize(): Int
    Definition Classes
    CloudStorageConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  33. def getState(): State

    Output only. An output-only field that indicates whether or not the
subscription can receive messages.


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

    returns

    The state.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  34. def getStateValue(): Int

    Output only. An output-only field that indicates whether or not the
subscription can receive messages.


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

    returns

    The enum numeric value on the wire for state.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  35. def getTextConfig(): TextConfig

    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.

    .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

    returns

    The textConfig.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  36. def getTextConfigOrBuilder(): TextConfigOrBuilder

    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.

    .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  37. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  38. def hasAvroConfig(): Boolean

    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.

    .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

    returns

    Whether the avroConfig field is set.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  39. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  40. def hasMaxDuration(): Boolean

    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.


    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;

    returns

    Whether the maxDuration field is set.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  41. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  42. def hasTextConfig(): Boolean

    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.

    .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

    returns

    Whether the textConfig field is set.

    Definition Classes
    CloudStorageConfig → CloudStorageConfigOrBuilder
    Annotations
    @Override()
  43. def hashCode(): Int
    Definition Classes
    CloudStorageConfig → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  44. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    CloudStorageConfig → GeneratedMessageV3
    Annotations
    @Override()
  45. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  46. final def isInitialized(): Boolean
    Definition Classes
    CloudStorageConfig → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  49. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException])
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    CloudStorageConfig → GeneratedMessageV3
    Annotations
    @Override()
  52. def newBuilderForType(): Builder
    Definition Classes
    CloudStorageConfig → Message → MessageLite
    Annotations
    @Override()
  53. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  54. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    CloudStorageConfig → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  55. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  57. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  58. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  59. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  60. def toBuilder(): Builder
    Definition Classes
    CloudStorageConfig → Message → MessageLite
    Annotations
    @Override()
  61. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  62. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  63. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  68. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  69. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    CloudStorageConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  70. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Inherited from CloudStorageConfigOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped