Struct google_api_proto::google::pubsub::v1::CloudStorageConfig

pub struct CloudStorageConfig {
    pub bucket: String,
    pub filename_prefix: String,
    pub filename_suffix: String,
    pub filename_datetime_format: String,
    pub max_duration: Option<Duration>,
    pub max_bytes: i64,
    pub max_messages: i64,
    pub state: i32,
    pub service_account_email: String,
    pub output_format: Option<OutputFormat>,
}

Configuration for a Cloud Storage subscription.

Fields

bucket: String

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

filename_prefix: String

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

filename_suffix: String

Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in “/”.

filename_datetime_format: String

Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.

max_duration: Option<Duration>

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.

max_bytes: i64

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.

max_messages: i64

Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.

state: i32

Output only. An output-only field that indicates whether or not the subscription can receive messages.

service_account_email: String

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.

output_format: Option<OutputFormat>

Defaults to text format.

Implementations

impl CloudStorageConfig

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for CloudStorageConfig

fn clone(&self) -> CloudStorageConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CloudStorageConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CloudStorageConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for CloudStorageConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CloudStorageConfig

fn eq(&self, other: &CloudStorageConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CloudStorageConfig