Class CloudStorageConfig (1.125.9)

public final class CloudStorageConfig extends GeneratedMessageV3 implements CloudStorageConfigOrBuilder

Configuration for a Cloud Storage subscription.

Protobuf type google.pubsub.v1.CloudStorageConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CloudStorageConfig

Implements

CloudStorageConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

Returns
Type	Description
`CloudStorageConfig`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CloudStorageConfig.Builder newBuilder()

Returns
Type	Description
`CloudStorageConfig.Builder`

newBuilder(CloudStorageConfig prototype)

public static CloudStorageConfig.Builder newBuilder(CloudStorageConfig prototype)

Parameter
Name	Description
`prototype`	`CloudStorageConfig`

Returns
Type	Description
`CloudStorageConfig.Builder`

parseDelimitedFrom(InputStream input)

public static CloudStorageConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CloudStorageConfig parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CloudStorageConfig parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CloudStorageConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CloudStorageConfig parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CloudStorageConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CloudStorageConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CloudStorageConfig> parser()

Returns
Type	Description
`Parser<CloudStorageConfig>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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;

Returns
Type	Description
`CloudStorageConfig.AvroConfig`	The avroConfig.

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;

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`

getFilenamePrefix()

public String getFilenamePrefix()

User-provided prefix for Cloud Storage filename. See the object naming requirements.

string filename_prefix = 2;

Returns
Type	Description
`String`	The filenamePrefix.

getFilenamePrefixBytes()

public ByteString getFilenamePrefixBytes()

User-provided prefix for Cloud Storage filename. See the object naming requirements.

string filename_prefix = 2;

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;

Returns
Type	Description
`DurationOrBuilder`

getOutputFormatCase()

public CloudStorageConfig.OutputFormatCase getOutputFormatCase()

Returns
Type	Description
`CloudStorageConfig.OutputFormatCase`

getParserForType()

public Parser<CloudStorageConfig> getParserForType()

Returns
Type	Description
`Parser<CloudStorageConfig>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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

If set, message data will be written to Cloud Storage in text format.

.google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4;

Returns
Type	Description
`CloudStorageConfig.TextConfig`	The textConfig.

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;

Returns
Type	Description
`CloudStorageConfig.TextConfigOrBuilder`

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

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CloudStorageConfig.Builder newBuilderForType()

Returns
Type	Description
`CloudStorageConfig.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CloudStorageConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`CloudStorageConfig.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CloudStorageConfig.Builder toBuilder()

Returns
Type	Description
`CloudStorageConfig.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`