Packages

t

com.google.pubsub.v1

CloudStorageConfigOrBuilder

trait CloudStorageConfigOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CloudStorageConfigOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  2. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAvroConfig(): AvroConfig

    Optional. If set, message data will be written to Cloud Storage in Avro
format.


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

    returns

    The avroConfig.

  4. abstract def getAvroConfigOrBuilder(): AvroConfigOrBuilder

    Optional. If set, message data will be written to Cloud Storage in Avro
format.


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

  5. abstract 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.

  6. abstract 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.

  7. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  8. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  9. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  10. abstract def getFilenameDatetimeFormat(): String

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


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

    string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The filenameDatetimeFormat.

  11. abstract def getFilenameDatetimeFormatBytes(): ByteString

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


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

    string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The bytes for filenameDatetimeFormat.

  12. abstract def getFilenamePrefix(): String

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


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

    returns

    The filenamePrefix.

  13. abstract def getFilenamePrefixBytes(): ByteString

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


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

    returns

    The bytes for filenamePrefix.

  14. abstract def getFilenameSuffix(): String

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


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

    returns

    The filenameSuffix.

  15. abstract def getFilenameSuffixBytes(): ByteString

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


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

    returns

    The bytes for filenameSuffix.

  16. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  17. abstract def getMaxBytes(): Long

    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.


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

    returns

    The maxBytes.

  18. abstract def getMaxDuration(): Duration

    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.


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

    returns

    The maxDuration.

  19. abstract def getMaxDurationOrBuilder(): DurationOrBuilder

    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.


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

  20. abstract def getMaxMessages(): Long

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


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

    int64 max_messages = 8 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The maxMessages.

  21. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  22. abstract def getOutputFormatCase(): OutputFormatCase
  23. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  24. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  25. abstract def getServiceAccountEmail(): String

    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.


    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.

    string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The serviceAccountEmail.

  26. abstract def getServiceAccountEmailBytes(): ByteString

    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.


    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.

    string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The bytes for serviceAccountEmail.

  27. abstract 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.

  28. abstract 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.

  29. abstract def getTextConfig(): TextConfig

    Optional. If set, message data will be written to Cloud Storage in text
format.


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

    returns

    The textConfig.

  30. abstract def getTextConfigOrBuilder(): TextConfigOrBuilder

    Optional. If set, message data will be written to Cloud Storage in text
format.


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

  31. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  32. abstract def hasAvroConfig(): Boolean

    Optional. If set, message data will be written to Cloud Storage in Avro
format.


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

    returns

    Whether the avroConfig field is set.

  33. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  34. abstract def hasMaxDuration(): Boolean

    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.


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

    returns

    Whether the maxDuration field is set.

  35. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  36. abstract def hasTextConfig(): Boolean

    Optional. If set, message data will be written to Cloud Storage in text
format.


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

    returns

    Whether the textConfig field is set.

  37. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

Concrete 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(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped