public static final class CloudStorageConfig.Builder extends GeneratedMessageV3.Builder<CloudStorageConfig.Builder> implements CloudStorageConfigOrBuilderConfiguration for a Cloud Storage subscription.
Protobuf type google.pubsub.v1.CloudStorageConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CloudStorageConfig.BuilderImplements
CloudStorageConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CloudStorageConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
build()
public CloudStorageConfig build()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig |
|
buildPartial()
public CloudStorageConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig |
|
clear()
public CloudStorageConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
clearAvroConfig()
public CloudStorageConfig.Builder clearAvroConfig()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
clearBucket()
public CloudStorageConfig.Builder clearBucket()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 |
CloudStorageConfig.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CloudStorageConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
clearFilenameDatetimeFormat()
public CloudStorageConfig.Builder clearFilenameDatetimeFormat()Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
clearFilenamePrefix()
public CloudStorageConfig.Builder clearFilenamePrefix()Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
clearFilenameSuffix()
public CloudStorageConfig.Builder clearFilenameSuffix()Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
clearMaxBytes()
public CloudStorageConfig.Builder clearMaxBytes()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
clearMaxDuration()
public CloudStorageConfig.Builder clearMaxDuration()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
clearMaxMessages()
public CloudStorageConfig.Builder clearMaxMessages()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CloudStorageConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
clearOutputFormat()
public CloudStorageConfig.Builder clearOutputFormat()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
clearServiceAccountEmail()
public CloudStorageConfig.Builder clearServiceAccountEmail() 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,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
clearState()
public CloudStorageConfig.Builder clearState()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 |
CloudStorageConfig.Builder |
This builder for chaining. |
clearTextConfig()
public CloudStorageConfig.Builder clearTextConfig()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
clone()
public CloudStorageConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
getAvroConfig()
public CloudStorageConfig.AvroConfig getAvroConfig()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig |
The avroConfig. |
getAvroConfigBuilder()
public CloudStorageConfig.AvroConfig.Builder getAvroConfigBuilder()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfig.Builder |
|
getAvroConfigOrBuilder()
public CloudStorageConfig.AvroConfigOrBuilder getAvroConfigOrBuilder()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.AvroConfigOrBuilder |
|
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()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilenameDatetimeFormat()
public String getFilenameDatetimeFormat()Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filenameDatetimeFormat. |
getFilenameDatetimeFormatBytes()
public ByteString getFilenameDatetimeFormatBytes()Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filenameDatetimeFormat. |
getFilenamePrefix()
public String getFilenamePrefix()Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filenamePrefix. |
getFilenamePrefixBytes()
public ByteString getFilenamePrefixBytes()Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filenamePrefix. |
getFilenameSuffix()
public String getFilenameSuffix()Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filenameSuffix. |
getFilenameSuffixBytes()
public ByteString getFilenameSuffixBytes()Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filenameSuffix. |
getMaxBytes()
public 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];
| Returns | |
|---|---|
| Type | Description |
long |
The maxBytes. |
getMaxDuration()
public Duration getMaxDuration()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 | |
|---|---|
| Type | Description |
Duration |
The maxDuration. |
getMaxDurationBuilder()
public Duration.Builder getMaxDurationBuilder()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 | |
|---|---|
| Type | Description |
Builder |
|
getMaxDurationOrBuilder()
public DurationOrBuilder getMaxDurationOrBuilder()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 | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMaxMessages()
public 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];
| Returns | |
|---|---|
| Type | Description |
long |
The maxMessages. |
getOutputFormatCase()
public CloudStorageConfig.OutputFormatCase getOutputFormatCase()| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.OutputFormatCase |
|
getServiceAccountEmail()
public 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,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountEmail. |
getServiceAccountEmailBytes()
public 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,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccountEmail. |
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];
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.State |
The state. |
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()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.TextConfig |
The textConfig. |
getTextConfigBuilder()
public CloudStorageConfig.TextConfig.Builder getTextConfigBuilder()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.TextConfig.Builder |
|
getTextConfigOrBuilder()
public CloudStorageConfig.TextConfigOrBuilder getTextConfigOrBuilder()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 | |
|---|---|
| Type | Description |
CloudStorageConfig.TextConfigOrBuilder |
|
hasAvroConfig()
public boolean hasAvroConfig()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 | |
|---|---|
| Type | Description |
boolean |
Whether the avroConfig field is set. |
hasMaxDuration()
public boolean hasMaxDuration()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 | |
|---|---|
| Type | Description |
boolean |
Whether the maxDuration field is set. |
hasTextConfig()
public boolean hasTextConfig()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 | |
|---|---|
| Type | Description |
boolean |
Whether the textConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAvroConfig(CloudStorageConfig.AvroConfig value)
public CloudStorageConfig.Builder mergeAvroConfig(CloudStorageConfig.AvroConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudStorageConfig.AvroConfig |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CloudStorageConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CloudStorageConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
mergeFrom(CloudStorageConfig other)
public CloudStorageConfig.Builder mergeFrom(CloudStorageConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
CloudStorageConfig |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
mergeMaxDuration(Duration value)
public CloudStorageConfig.Builder mergeMaxDuration(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
mergeTextConfig(CloudStorageConfig.TextConfig value)
public CloudStorageConfig.Builder mergeTextConfig(CloudStorageConfig.TextConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudStorageConfig.TextConfig |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CloudStorageConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setAvroConfig(CloudStorageConfig.AvroConfig value)
public CloudStorageConfig.Builder setAvroConfig(CloudStorageConfig.AvroConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudStorageConfig.AvroConfig |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setAvroConfig(CloudStorageConfig.AvroConfig.Builder builderForValue)
public CloudStorageConfig.Builder setAvroConfig(CloudStorageConfig.AvroConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CloudStorageConfig.AvroConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setBucket(String value)
public CloudStorageConfig.Builder setBucket(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe bucket to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setBucketBytes(ByteString value)
public CloudStorageConfig.Builder setBucketBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for bucket to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CloudStorageConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setFilenameDatetimeFormat(String value)
public CloudStorageConfig.Builder setFilenameDatetimeFormat(String value)Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filenameDatetimeFormat to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setFilenameDatetimeFormatBytes(ByteString value)
public CloudStorageConfig.Builder setFilenameDatetimeFormatBytes(ByteString value)Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
string filename_datetime_format = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filenameDatetimeFormat to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setFilenamePrefix(String value)
public CloudStorageConfig.Builder setFilenamePrefix(String value)Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filenamePrefix to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setFilenamePrefixBytes(ByteString value)
public CloudStorageConfig.Builder setFilenamePrefixBytes(ByteString value)Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filenamePrefix to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setFilenameSuffix(String value)
public CloudStorageConfig.Builder setFilenameSuffix(String value)Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filenameSuffix to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setFilenameSuffixBytes(ByteString value)
public CloudStorageConfig.Builder setFilenameSuffixBytes(ByteString value)Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filenameSuffix to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setMaxBytes(long value)
public CloudStorageConfig.Builder setMaxBytes(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe maxBytes to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setMaxDuration(Duration value)
public CloudStorageConfig.Builder setMaxDuration(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setMaxDuration(Duration.Builder builderForValue)
public CloudStorageConfig.Builder setMaxDuration(Duration.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setMaxMessages(long value)
public CloudStorageConfig.Builder setMaxMessages(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe maxMessages to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CloudStorageConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setServiceAccountEmail(String value)
public CloudStorageConfig.Builder setServiceAccountEmail(String value) 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,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe serviceAccountEmail to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setServiceAccountEmailBytes(ByteString value)
public CloudStorageConfig.Builder setServiceAccountEmailBytes(ByteString value) 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,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
string service_account_email = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for serviceAccountEmail to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setState(CloudStorageConfig.State value)
public CloudStorageConfig.Builder setState(CloudStorageConfig.State value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudStorageConfig.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setStateValue(int value)
public CloudStorageConfig.Builder setStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
This builder for chaining. |
setTextConfig(CloudStorageConfig.TextConfig value)
public CloudStorageConfig.Builder setTextConfig(CloudStorageConfig.TextConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudStorageConfig.TextConfig |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setTextConfig(CloudStorageConfig.TextConfig.Builder builderForValue)
public CloudStorageConfig.Builder setTextConfig(CloudStorageConfig.TextConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CloudStorageConfig.TextConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CloudStorageConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder |
|