Class CloudStorageConfig (1.123.18)
Version 1.123.18keyboard_arrow_down
public final class CloudStorageConfig extends GeneratedMessageV3 implements CloudStorageConfigOrBuilder
Configuration for a Cloud Storage subscription.
Protobuf type google.pubsub.v1.CloudStorageConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AVRO_CONFIG_FIELD_NUMBER
public static final int AVRO_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
BUCKET_FIELD_NUMBER
public static final int BUCKET_FIELD_NUMBER
Field Value
Type Description
int
FILENAME_PREFIX_FIELD_NUMBER
public static final int FILENAME_PREFIX_FIELD_NUMBER
Field Value
Type Description
int
FILENAME_SUFFIX_FIELD_NUMBER
public static final int FILENAME_SUFFIX_FIELD_NUMBER
Field Value
Type Description
int
MAX_BYTES_FIELD_NUMBER
public static final int MAX_BYTES_FIELD_NUMBER
Field Value
Type Description
int
MAX_DURATION_FIELD_NUMBER
public static final int MAX_DURATION_FIELD_NUMBER
Field Value
Type Description
int
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
TEXT_CONFIG_FIELD_NUMBER
public static final int TEXT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static CloudStorageConfig getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static CloudStorageConfig . Builder newBuilder ()
newBuilder(CloudStorageConfig prototype)
public static CloudStorageConfig . Builder newBuilder ( CloudStorageConfig prototype )
public static CloudStorageConfig parseDelimitedFrom ( InputStream input )
public static CloudStorageConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static CloudStorageConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static CloudStorageConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CloudStorageConfig parseFrom ( CodedInputStream input )
public static CloudStorageConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CloudStorageConfig parseFrom ( InputStream input )
public static CloudStorageConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static CloudStorageConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CloudStorageConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<CloudStorageConfig> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAvroConfig()
public CloudStorageConfig . AvroConfig getAvroConfig ()
If set, message data will be written to Cloud Storage in Avro format.
.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;
getAvroConfigOrBuilder()
public CloudStorageConfig . AvroConfigOrBuilder getAvroConfigOrBuilder ()
If set, message data will be written to Cloud Storage in Avro format.
.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;
getBucket()
public String getBucket ()
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 .
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The bucket.
getBucketBytes()
public ByteString getBucketBytes ()
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 .
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for bucket.
getDefaultInstanceForType()
public CloudStorageConfig getDefaultInstanceForType ()
getFilenamePrefix()
public String getFilenamePrefix ()
Returns
Type Description
String The filenamePrefix.
getFilenamePrefixBytes()
public ByteString getFilenamePrefixBytes ()
Returns
Type Description
ByteString The bytes for filenamePrefix.
getFilenameSuffix()
public String getFilenameSuffix ()
User-provided suffix for Cloud Storage filename. See the object naming
requirements . Must
not end in "/".
string filename_suffix = 3;
Returns
Type Description
String The filenameSuffix.
getFilenameSuffixBytes()
public ByteString getFilenameSuffixBytes ()
User-provided suffix for Cloud Storage filename. See the object naming
requirements . Must
not end in "/".
string filename_suffix = 3;
Returns
Type Description
ByteString The bytes for filenameSuffix.
getMaxBytes()
public long getMaxBytes ()
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
Type Description
long The maxBytes.
getMaxDuration()
public Duration getMaxDuration ()
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
Type Description
Duration The maxDuration.
getMaxDurationOrBuilder()
public DurationOrBuilder getMaxDurationOrBuilder ()
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;
public CloudStorageConfig . OutputFormatCase getOutputFormatCase ()
getParserForType()
public Parser<CloudStorageConfig> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getState()
public CloudStorageConfig . State getState ()
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];
getStateValue()
public int getStateValue ()
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
Type Description
int The enum numeric value on the wire for state.
getTextConfig()
public CloudStorageConfig . TextConfig getTextConfig ()
If set, message data will be written to Cloud Storage in text format.
.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;
getTextConfigOrBuilder()
public CloudStorageConfig . TextConfigOrBuilder getTextConfigOrBuilder ()
If set, message data will be written to Cloud Storage in text format.
.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;
hasAvroConfig()
public boolean hasAvroConfig ()
If set, message data will be written to Cloud Storage in Avro format.
.google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;
Returns
Type Description
boolean Whether the avroConfig field is set.
hasMaxDuration()
public boolean hasMaxDuration ()
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
Type Description
boolean Whether the maxDuration field is set.
hasTextConfig()
public boolean hasTextConfig ()
If set, message data will be written to Cloud Storage in text format.
.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;
Returns
Type Description
boolean Whether the textConfig field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public CloudStorageConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CloudStorageConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public CloudStorageConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
