final case class CloudStorageConfig(bucket: String = "", filenamePrefix: String = "", filenameSuffix: String = "", filenameDatetimeFormat: String = "", outputFormat: OutputFormat = com.google.pubsub.v1.pubsub.CloudStorageConfig.OutputFormat.Empty, maxDuration: Option[Duration] = _root_.scala.None, maxBytes: Long = 0L, maxMessages: Long = 0L, state: State = com.google.pubsub.v1.pubsub.CloudStorageConfig.State.STATE_UNSPECIFIED, serviceAccountEmail: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CloudStorageConfig] with Product with Serializable

Configuration for a Cloud Storage subscription.

bucket

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

filenamePrefix

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

filenameSuffix

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 "/".

filenameDatetimeFormat

Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).

maxDuration

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 acknowledgment deadline.

maxBytes

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.

maxMessages

Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.

state

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

serviceAccountEmail

Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

Annotations
@SerialVersionUID()
Source
CloudStorageConfig.scala
Linear Supertypes
Updatable[CloudStorageConfig], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CloudStorageConfig
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CloudStorageConfig(bucket: String = "", filenamePrefix: String = "", filenameSuffix: String = "", filenameDatetimeFormat: String = "", outputFormat: OutputFormat = com.google.pubsub.v1.pubsub.CloudStorageConfig.OutputFormat.Empty, maxDuration: Option[Duration] = _root_.scala.None, maxBytes: Long = 0L, maxMessages: Long = 0L, state: State = com.google.pubsub.v1.pubsub.CloudStorageConfig.State.STATE_UNSPECIFIED, serviceAccountEmail: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    bucket

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

    filenamePrefix

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

    filenameSuffix

    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 "/".

    filenameDatetimeFormat

    Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).

    maxDuration

    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 acknowledgment deadline.

    maxBytes

    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.

    maxMessages

    Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.

    state

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

    serviceAccountEmail

    Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

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. val bucket: String
  6. def clearMaxDuration: CloudStorageConfig
  7. def clearOutputFormat: CloudStorageConfig
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. def companion: CloudStorageConfig.type
    Definition Classes
    CloudStorageConfig → GeneratedMessage
  10. def discardUnknownFields: CloudStorageConfig
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val filenameDatetimeFormat: String
  13. val filenamePrefix: String
  14. val filenameSuffix: String
  15. def getAvroConfig: AvroConfig
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    CloudStorageConfig → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    CloudStorageConfig → GeneratedMessage
  19. def getMaxDuration: Duration
  20. def getTextConfig: TextConfig
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val maxBytes: Long
  23. val maxDuration: Option[Duration]
  24. val maxMessages: Long
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. val outputFormat: OutputFormat
  29. def productElementNames: Iterator[String]
    Definition Classes
    Product
  30. def serializedSize: Int
    Definition Classes
    CloudStorageConfig → GeneratedMessage
  31. val serviceAccountEmail: String
  32. val state: State
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  35. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  36. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  37. def toProtoString: String
    Definition Classes
    CloudStorageConfig → GeneratedMessage
  38. val unknownFields: UnknownFieldSet
  39. def update(ms: (Lens[CloudStorageConfig, CloudStorageConfig]) => Mutation[CloudStorageConfig]*): CloudStorageConfig
    Definition Classes
    Updatable
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. def withAvroConfig(__v: AvroConfig): CloudStorageConfig
  44. def withBucket(__v: String): CloudStorageConfig
  45. def withFilenameDatetimeFormat(__v: String): CloudStorageConfig
  46. def withFilenamePrefix(__v: String): CloudStorageConfig
  47. def withFilenameSuffix(__v: String): CloudStorageConfig
  48. def withMaxBytes(__v: Long): CloudStorageConfig
  49. def withMaxDuration(__v: Duration): CloudStorageConfig
  50. def withMaxMessages(__v: Long): CloudStorageConfig
  51. def withOutputFormat(__v: OutputFormat): CloudStorageConfig
  52. def withServiceAccountEmail(__v: String): CloudStorageConfig
  53. def withState(__v: State): CloudStorageConfig
  54. def withTextConfig(__v: TextConfig): CloudStorageConfig
  55. def withUnknownFields(__v: UnknownFieldSet): CloudStorageConfig
  56. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  57. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    CloudStorageConfig → GeneratedMessage
  58. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Updatable[CloudStorageConfig]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped