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 Details

    • 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()
       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];
      Returns:
      The filenamePrefix.

    • getFilenamePrefixBytes

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

    • getFilenameSuffix

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

    • getFilenameSuffixBytes

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

    • getFilenameDatetimeFormat

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

    • getFilenameDatetimeFormatBytes

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

    • hasTextConfig

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

    • getTextConfig

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

    • getTextConfigOrBuilder

      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];

    • hasAvroConfig

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

    • getAvroConfig

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

    • getAvroConfigOrBuilder

      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];

    • hasMaxDuration

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

    • getMaxDuration

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

    • getMaxDurationOrBuilder

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

    • getMaxBytes

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

    • getMaxMessages

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

    • 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.

    • getServiceAccountEmail

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

    • getServiceAccountEmailBytes

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

    • getOutputFormatCase

      CloudStorageConfig.OutputFormatCase getOutputFormatCase()