final class CloudStorageConfig extends GeneratedMessageV3 with CloudStorageConfigOrBuilder
Configuration for a Cloud Storage subscription.
Protobuf type google.pubsub.v1.CloudStorageConfig
- Source
- CloudStorageConfig.java
- Alphabetic
- By Inheritance
- CloudStorageConfig
- CloudStorageConfigOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
- 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
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()
- 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()
- 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 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()
- 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()
- 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()
- 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()
- def getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
- 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()
- 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()
- 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()
- 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 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
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()
- 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()
- def getUnknownFields(): UnknownFieldSet
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- 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()
- def hasField(arg0: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- 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()
- def hasOneof(arg0: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- 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()
- 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
- def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[com.google.protobuf.InvalidProtocolBufferException])
- 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])