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

Alphabetic
By Inheritance

Inherited

CloudStorageConfig
CloudStorageConfigOrBuilder
GeneratedMessageV3
Serializable
AbstractMessage
Message
MessageOrBuilder
AbstractMessageLite
MessageLite
MessageLiteOrBuilder
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(obj: AnyRef): Boolean
Definition Classes
CloudStorageConfig → AbstractMessage → Message → AnyRef → Any
Annotations
@Override()
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def findInitializationErrors(): List[String]
Definition Classes
AbstractMessage → MessageOrBuilder
def getAllFields(): Map[FieldDescriptor, AnyRef]
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
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.
Definition Classes
CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations
@Override()
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];
Definition Classes
CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations
@Override()

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

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

final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def getDefaultInstanceForType(): CloudStorageConfig
Definition Classes
CloudStorageConfig → MessageOrBuilder → MessageLiteOrBuilder
Annotations
@Override()
def getDescriptorForType(): Descriptor
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
def getField(arg0: FieldDescriptor): AnyRef
Definition Classes
GeneratedMessageV3 → MessageOrBuilder

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

def getInitializationErrorString(): String
Definition Classes
AbstractMessage → MessageOrBuilder

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
Definition Classes
GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
def getOutputFormatCase(): OutputFormatCase
Definition Classes
CloudStorageConfig → CloudStorageConfigOrBuilder
def getParserForType(): Parser[CloudStorageConfig]
Definition Classes
CloudStorageConfig → GeneratedMessageV3 → Message → MessageLite
Annotations
@Override()
def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
def getRepeatedFieldCount(arg0: FieldDescriptor): Int
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
def getSerializedSize(): Int
Definition Classes
CloudStorageConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
Annotations
@Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

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()
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()
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.
Definition Classes
CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations
@Override()
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];
Definition Classes
CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations
@Override()
def getUnknownFields(): UnknownFieldSet
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
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.
Definition Classes
CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations
@Override()
def hasField(arg0: FieldDescriptor): Boolean
Definition Classes
GeneratedMessageV3 → MessageOrBuilder

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.

Definition Classes: CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations: @Override()

def hasOneof(arg0: OneofDescriptor): Boolean
Definition Classes
GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
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.
Definition Classes
CloudStorageConfig → CloudStorageConfigOrBuilder
Annotations
@Override()
def hashCode(): Int
Definition Classes
CloudStorageConfig → AbstractMessage → Message → AnyRef → Any
Annotations
@Override()
def internalGetFieldAccessorTable(): FieldAccessorTable
Attributes
protected[v1]
Definition Classes
CloudStorageConfig → GeneratedMessageV3
Annotations
@Override()
def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
final def isInitialized(): Boolean
Definition Classes
CloudStorageConfig → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
Annotations
@Override()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def makeExtensionsImmutable(): Unit
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def newBuilderForType(parent: BuilderParent): Builder
Attributes
protected[v1]
Definition Classes
CloudStorageConfig → GeneratedMessageV3
Annotations
@Override()
def newBuilderForType(): Builder
Definition Classes
CloudStorageConfig → Message → MessageLite
Annotations
@Override()
def newBuilderForType(arg0: BuilderParent): Builder
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3 → AbstractMessage
def newInstance(unused: UnusedPrivateParameter): AnyRef
Attributes
protected[v1]
Definition Classes
CloudStorageConfig → GeneratedMessageV3
Annotations
@Override() @SuppressWarnings()
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[java.io.IOException])
def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[java.io.IOException])
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toBuilder(): Builder
Definition Classes
CloudStorageConfig → Message → MessageLite
Annotations
@Override()
def toByteArray(): Array[Byte]
Definition Classes
AbstractMessageLite → MessageLite
def toByteString(): ByteString
Definition Classes
AbstractMessageLite → MessageLite
final def toString(): String
Definition Classes
AbstractMessage → Message → AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
def writeDelimitedTo(arg0: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])
def writeReplace(): AnyRef
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[java.io.ObjectStreamException])
def writeTo(output: CodedOutputStream): Unit
Definition Classes
CloudStorageConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
Annotations
@Override()
def writeTo(arg0: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])

Deprecated Value Members

def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
Deprecated

Packages

CloudStorageConfig

final class CloudStorageConfig extends GeneratedMessageV3 with CloudStorageConfigOrBuilder

Value Members

Deprecated Value Members

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

Packages

CloudStorageConfig

final class CloudStorageConfig extends GeneratedMessageV3 with CloudStorageConfigOrBuilder

Value Members

Deprecated Value Members

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

CloudStorageConfig