Struct StorageFormat 

#[non_exhaustive]
pub struct StorageFormat {
    pub format: Format,
    pub compression_format: CompressionFormat,
    pub mime_type: String,
    pub options: Option<Options>,
    /* private fields */
}

Describes the format of the data within its storage location.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: Format

Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.

compression_format: CompressionFormat

Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.

mime_type: String

Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values:

• application/x-parquet
• application/x-avro
• application/x-orc
• application/x-tfrecord
• application/x-parquet+iceberg
• application/x-avro+iceberg
• application/x-orc+iceberg
• application/json
• application/{subtypes}
• text/csv
• text/<subtypes>
• image/{image subtype}
• video/{video subtype}
• audio/{audio subtype}

options: Option<Options>

Additional format-specific options.

Implementations

impl StorageFormat

pub fn new() -> Self

Creates a new default instance.

pub fn set_format<T: Into<Format>>(self, v: T) -> Self

Sets the value of format.

Example

use google_cloud_dataplex_v1::model::storage_format::Format;
let x0 = StorageFormat::new().set_format(Format::Parquet);
let x1 = StorageFormat::new().set_format(Format::Avro);
let x2 = StorageFormat::new().set_format(Format::Orc);

pub fn set_compression_format<T: Into<CompressionFormat>>(self, v: T) -> Self

Sets the value of compression_format.

Example

use google_cloud_dataplex_v1::model::storage_format::CompressionFormat;
let x0 = StorageFormat::new().set_compression_format(CompressionFormat::Gzip);
let x1 = StorageFormat::new().set_compression_format(CompressionFormat::Bzip2);

pub fn set_mime_type<T: Into<String>>(self, v: T) -> Self

Sets the value of mime_type.

Example

let x = StorageFormat::new().set_mime_type("example");

pub fn set_options<T: Into<Option<Options>>>(self, v: T) -> Self

Sets the value of options.

Note that all the setters affecting options are mutually exclusive.

Example

use google_cloud_dataplex_v1::model::storage_format::CsvOptions;
let x = StorageFormat::new().set_options(Some(
    google_cloud_dataplex_v1::model::storage_format::Options::Csv(CsvOptions::default().into())));

pub fn csv(&self) -> Option<&Box<CsvOptions>>

The value of options if it holds a Csv, None if the field is not set or holds a different branch.

pub fn set_csv<T: Into<Box<CsvOptions>>>(self, v: T) -> Self

Sets the value of options to hold a Csv.

Note that all the setters affecting options are mutually exclusive.

Example

use google_cloud_dataplex_v1::model::storage_format::CsvOptions;
let x = StorageFormat::new().set_csv(CsvOptions::default()/* use setters */);
assert!(x.csv().is_some());
assert!(x.json().is_none());
assert!(x.iceberg().is_none());

pub fn json(&self) -> Option<&Box<JsonOptions>>

The value of options if it holds a Json, None if the field is not set or holds a different branch.

pub fn set_json<T: Into<Box<JsonOptions>>>(self, v: T) -> Self

Sets the value of options to hold a Json.

Note that all the setters affecting options are mutually exclusive.

Example

use google_cloud_dataplex_v1::model::storage_format::JsonOptions;
let x = StorageFormat::new().set_json(JsonOptions::default()/* use setters */);
assert!(x.json().is_some());
assert!(x.csv().is_none());
assert!(x.iceberg().is_none());

pub fn iceberg(&self) -> Option<&Box<IcebergOptions>>

The value of options if it holds a Iceberg, None if the field is not set or holds a different branch.

pub fn set_iceberg<T: Into<Box<IcebergOptions>>>(self, v: T) -> Self

Sets the value of options to hold a Iceberg.

Note that all the setters affecting options are mutually exclusive.

Example

use google_cloud_dataplex_v1::model::storage_format::IcebergOptions;
let x = StorageFormat::new().set_iceberg(IcebergOptions::default()/* use setters */);
assert!(x.iceberg().is_some());
assert!(x.csv().is_none());
assert!(x.json().is_none());

Trait Implementations

impl Clone for StorageFormat

fn clone(&self) -> StorageFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageFormat

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

Formats the value using the given formatter.

impl Default for StorageFormat

fn default() -> StorageFormat

Returns the “default value” for a type.

impl Message for StorageFormat

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StorageFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StorageFormat