public final class CloudStorageConfig extends com.google.protobuf.GeneratedMessageV3 implements CloudStorageConfigOrBuilder
Configuration for a Cloud Storage subscription.Protobuf type
google.cloud.bigquery.analyticshub.v1.CloudStorageConfig| Modifier and Type | Class and Description |
|---|---|
static class |
CloudStorageConfig.AvroConfig
Configuration for writing message data in Avro format.
|
static interface |
CloudStorageConfig.AvroConfigOrBuilder |
static class |
CloudStorageConfig.Builder
Configuration for a Cloud Storage subscription.
|
static class |
CloudStorageConfig.OutputFormatCase |
static class |
CloudStorageConfig.TextConfig
Configuration for writing message data in text format.
|
static interface |
CloudStorageConfig.TextConfigOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
AVRO_CONFIG_FIELD_NUMBER |
static int |
BUCKET_FIELD_NUMBER |
static int |
FILENAME_DATETIME_FORMAT_FIELD_NUMBER |
static int |
FILENAME_PREFIX_FIELD_NUMBER |
static int |
FILENAME_SUFFIX_FIELD_NUMBER |
static int |
MAX_BYTES_FIELD_NUMBER |
static int |
MAX_DURATION_FIELD_NUMBER |
static int |
MAX_MESSAGES_FIELD_NUMBER |
static int |
SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER |
static int |
TEXT_CONFIG_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
CloudStorageConfig.AvroConfig |
getAvroConfig()
Optional.
|
CloudStorageConfig.AvroConfigOrBuilder |
getAvroConfigOrBuilder()
Optional.
|
String |
getBucket()
Required.
|
com.google.protobuf.ByteString |
getBucketBytes()
Required.
|
static CloudStorageConfig |
getDefaultInstance() |
CloudStorageConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getFilenameDatetimeFormat()
Optional.
|
com.google.protobuf.ByteString |
getFilenameDatetimeFormatBytes()
Optional.
|
String |
getFilenamePrefix()
Optional.
|
com.google.protobuf.ByteString |
getFilenamePrefixBytes()
Optional.
|
String |
getFilenameSuffix()
Optional.
|
com.google.protobuf.ByteString |
getFilenameSuffixBytes()
Optional.
|
long |
getMaxBytes()
Optional.
|
com.google.protobuf.Duration |
getMaxDuration()
Optional.
|
com.google.protobuf.DurationOrBuilder |
getMaxDurationOrBuilder()
Optional.
|
long |
getMaxMessages()
Optional.
|
CloudStorageConfig.OutputFormatCase |
getOutputFormatCase() |
com.google.protobuf.Parser<CloudStorageConfig> |
getParserForType() |
int |
getSerializedSize() |
String |
getServiceAccountEmail()
Optional.
|
com.google.protobuf.ByteString |
getServiceAccountEmailBytes()
Optional.
|
CloudStorageConfig.TextConfig |
getTextConfig()
Optional.
|
CloudStorageConfig.TextConfigOrBuilder |
getTextConfigOrBuilder()
Optional.
|
boolean |
hasAvroConfig()
Optional.
|
int |
hashCode() |
boolean |
hasMaxDuration()
Optional.
|
boolean |
hasTextConfig()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static CloudStorageConfig.Builder |
newBuilder() |
static CloudStorageConfig.Builder |
newBuilder(CloudStorageConfig prototype) |
CloudStorageConfig.Builder |
newBuilderForType() |
protected CloudStorageConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static CloudStorageConfig |
parseDelimitedFrom(InputStream input) |
static CloudStorageConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageConfig |
parseFrom(byte[] data) |
static CloudStorageConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageConfig |
parseFrom(ByteBuffer data) |
static CloudStorageConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageConfig |
parseFrom(com.google.protobuf.ByteString data) |
static CloudStorageConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static CloudStorageConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageConfig |
parseFrom(InputStream input) |
static CloudStorageConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<CloudStorageConfig> |
parser() |
CloudStorageConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TEXT_CONFIG_FIELD_NUMBER
public static final int AVRO_CONFIG_FIELD_NUMBER
public static final int BUCKET_FIELD_NUMBER
public static final int FILENAME_PREFIX_FIELD_NUMBER
public static final int FILENAME_SUFFIX_FIELD_NUMBER
public static final int FILENAME_DATETIME_FORMAT_FIELD_NUMBER
public static final int MAX_DURATION_FIELD_NUMBER
public static final int MAX_BYTES_FIELD_NUMBER
public static final int MAX_MESSAGES_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public CloudStorageConfig.OutputFormatCase getOutputFormatCase()
getOutputFormatCase in interface CloudStorageConfigOrBuilderpublic boolean hasTextConfig()
Optional. If set, message data will be written to Cloud Storage in text format.
.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
hasTextConfig in interface CloudStorageConfigOrBuilderpublic CloudStorageConfig.TextConfig getTextConfig()
Optional. If set, message data will be written to Cloud Storage in text format.
.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
getTextConfig in interface CloudStorageConfigOrBuilderpublic CloudStorageConfig.TextConfigOrBuilder getTextConfigOrBuilder()
Optional. If set, message data will be written to Cloud Storage in text format.
.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL];
getTextConfigOrBuilder in interface CloudStorageConfigOrBuilderpublic boolean hasAvroConfig()
Optional. If set, message data will be written to Cloud Storage in Avro format.
.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
hasAvroConfig in interface CloudStorageConfigOrBuilderpublic CloudStorageConfig.AvroConfig getAvroConfig()
Optional. If set, message data will be written to Cloud Storage in Avro format.
.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getAvroConfig in interface CloudStorageConfigOrBuilderpublic CloudStorageConfig.AvroConfigOrBuilder getAvroConfigOrBuilder()
Optional. If set, message data will be written to Cloud Storage in Avro format.
.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getAvroConfigOrBuilder in interface CloudStorageConfigOrBuilderpublic 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] (https://cloud.google.com/storage/docs/buckets#naming).
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];getBucket in interface CloudStorageConfigOrBuilderpublic com.google.protobuf.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] (https://cloud.google.com/storage/docs/buckets#naming).
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];getBucketBytes in interface CloudStorageConfigOrBuilderpublic String getFilenamePrefix()
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];getFilenamePrefix in interface CloudStorageConfigOrBuilderpublic com.google.protobuf.ByteString getFilenamePrefixBytes()
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];getFilenamePrefixBytes in interface CloudStorageConfigOrBuilderpublic String getFilenameSuffix()
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];getFilenameSuffix in interface CloudStorageConfigOrBuilderpublic com.google.protobuf.ByteString getFilenameSuffixBytes()
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];getFilenameSuffixBytes in interface CloudStorageConfigOrBuilderpublic String getFilenameDatetimeFormat()
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];getFilenameDatetimeFormat in interface CloudStorageConfigOrBuilderpublic com.google.protobuf.ByteString getFilenameDatetimeFormatBytes()
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];getFilenameDatetimeFormatBytes in interface CloudStorageConfigOrBuilderpublic boolean hasMaxDuration()
Optional. File batching settings. If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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];
hasMaxDuration in interface CloudStorageConfigOrBuilderpublic com.google.protobuf.Duration getMaxDuration()
Optional. File batching settings. If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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];
getMaxDuration in interface CloudStorageConfigOrBuilderpublic com.google.protobuf.DurationOrBuilder getMaxDurationOrBuilder()
Optional. File batching settings. If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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];
getMaxDurationOrBuilder in interface CloudStorageConfigOrBuilderpublic long getMaxBytes()
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];getMaxBytes in interface CloudStorageConfigOrBuilderpublic long getMaxMessages()
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];getMaxMessages in interface CloudStorageConfigOrBuilderpublic String getServiceAccountEmail()
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];getServiceAccountEmail in interface CloudStorageConfigOrBuilderpublic com.google.protobuf.ByteString getServiceAccountEmailBytes()
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];getServiceAccountEmailBytes in interface CloudStorageConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static CloudStorageConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static CloudStorageConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CloudStorageConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static CloudStorageConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CloudStorageConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static CloudStorageConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic CloudStorageConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static CloudStorageConfig.Builder newBuilder()
public static CloudStorageConfig.Builder newBuilder(CloudStorageConfig prototype)
public CloudStorageConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected CloudStorageConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static CloudStorageConfig getDefaultInstance()
public static com.google.protobuf.Parser<CloudStorageConfig> parser()
public com.google.protobuf.Parser<CloudStorageConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public CloudStorageConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.