Package com.google.pubsub.v1

Interface CloudStorageConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CloudStorageConfig, CloudStorageConfig.Builder
    public interface CloudStorageConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getBucket

        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];
        Returns:
        The bucket.

      • getBucketBytes

        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];
        Returns:
        The bytes for bucket.

      • getFilenamePrefix

        String getFilenamePrefix()
         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.

      • getFilenamePrefixBytes

        com.google.protobuf.ByteString getFilenamePrefixBytes()
         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.

      • getFilenameSuffix

        String getFilenameSuffix()
         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.

      • getFilenameSuffixBytes

        com.google.protobuf.ByteString getFilenameSuffixBytes()
         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.

      • hasTextConfig

        boolean hasTextConfig()
         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.

      • getTextConfig

        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:
        The textConfig.

      • getTextConfigOrBuilder

        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

        boolean hasAvroConfig()
         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.

      • getAvroConfig

        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:
        The avroConfig.

      • getAvroConfigOrBuilder

        CloudStorageConfig.AvroConfigOrBuilder getAvroConfigOrBuilder()
         If set, message data will be written to Cloud Storage in Avro format.
        .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5;

      • hasMaxDuration

        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:
        Whether the maxDuration field is set.

      • getMaxDuration

        com.google.protobuf.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:
        The maxDuration.

      • getMaxDurationOrBuilder

        com.google.protobuf.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;

      • getMaxBytes

        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:
        The maxBytes.

      • getStateValue

        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:
        The enum numeric value on the wire for state.

      • getState

        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:
        The state.