Dataplex V1 API - Class Google::Cloud::Dataplex::V1::StorageFormat (v1.4.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::StorageFormat.

Describes the format of the data within its storage location.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#compression_format

def compression_format() -> ::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat) — Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.

#compression_format=

def compression_format=(value) -> ::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat

Parameter

value (::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat) — Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat) — Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.

#csv

def csv() -> ::Google::Cloud::Dataplex::V1::StorageFormat::CsvOptions

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::CsvOptions) — Optional. Additional information about CSV formatted data.

Note: The following fields are mutually exclusive: csv, json, iceberg. If a field in that set is populated, all other fields in the set will automatically be cleared.

#csv=

def csv=(value) -> ::Google::Cloud::Dataplex::V1::StorageFormat::CsvOptions

Parameter

value (::Google::Cloud::Dataplex::V1::StorageFormat::CsvOptions) — Optional. Additional information about CSV formatted data.

Note: The following fields are mutually exclusive: csv, json, iceberg. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::CsvOptions) — Optional. Additional information about CSV formatted data.

Note: The following fields are mutually exclusive: csv, json, iceberg. If a field in that set is populated, all other fields in the set will automatically be cleared.

#format

def format() -> ::Google::Cloud::Dataplex::V1::StorageFormat::Format

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::Format) — Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.

#iceberg

def iceberg() -> ::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions) — Optional. Additional information about iceberg tables.

Note: The following fields are mutually exclusive: iceberg, csv, json. If a field in that set is populated, all other fields in the set will automatically be cleared.

#iceberg=

def iceberg=(value) -> ::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions

Parameter

value (::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions) — Optional. Additional information about iceberg tables.

Note: The following fields are mutually exclusive: iceberg, csv, json. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions) — Optional. Additional information about iceberg tables.

Note: The following fields are mutually exclusive: iceberg, csv, json. If a field in that set is populated, all other fields in the set will automatically be cleared.

#json

def json() -> ::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions) — Optional. Additional information about CSV formatted data.

Note: The following fields are mutually exclusive: json, csv, iceberg. If a field in that set is populated, all other fields in the set will automatically be cleared.

#json=

def json=(value) -> ::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions

Parameter

value (::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions) — Optional. Additional information about CSV formatted data.

Note: The following fields are mutually exclusive: json, csv, iceberg. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions) — Optional. Additional information about CSV formatted data.

Note: The following fields are mutually exclusive: json, csv, iceberg. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mime_type

def mime_type() -> ::String

Returns

(::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/
- image/{image subtype}
- video/{video subtype}
- audio/{audio subtype}

#mime_type=

def mime_type=(value) -> ::String

Parameter

value (::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/
- image/{image subtype}
- video/{video subtype}
- audio/{audio subtype}

Returns

(::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/
- image/{image subtype}
- video/{video subtype}
- audio/{audio subtype}