Reference documentation and code samples for the Google Cloud Dataplex V1 Client class StorageFormat.
Describes the format of the data within its storage location.
Generated from protobuf message google.cloud.dataplex.v1.StorageFormat
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ format |
int
Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type. |
↳ compression_format |
int
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/
|
↳ csv |
Google\Cloud\Dataplex\V1\StorageFormat\CsvOptions
Optional. Additional information about CSV formatted data. |
↳ json |
Google\Cloud\Dataplex\V1\StorageFormat\JsonOptions
Optional. Additional information about CSV formatted data. |
↳ iceberg |
Google\Cloud\Dataplex\V1\StorageFormat\IcebergOptions
Optional. Additional information about iceberg tables. |
getFormat
Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
| Returns | |
|---|---|
| Type | Description |
int | |
setFormat
Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompressionFormat
Optional. The compression type associated with the stored data.
If unspecified, the data is uncompressed.
| Returns | |
|---|---|
| Type | Description |
int | |
setCompressionFormat
Optional. The compression type associated with the stored data.
If unspecified, the data is uncompressed.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMimeType
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 | |
|---|---|
| Type | Description |
string | |
setMimeType
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCsv
Optional. Additional information about CSV formatted data.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\StorageFormat\CsvOptions|null | |
hasCsv
setCsv
Optional. Additional information about CSV formatted data.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\StorageFormat\CsvOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJson
Optional. Additional information about CSV formatted data.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\StorageFormat\JsonOptions|null | |
hasJson
setJson
Optional. Additional information about CSV formatted data.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\StorageFormat\JsonOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIceberg
Optional. Additional information about iceberg tables.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\StorageFormat\IcebergOptions|null | |
hasIceberg
setIceberg
Optional. Additional information about iceberg tables.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\StorageFormat\IcebergOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOptions
| Returns | |
|---|---|
| Type | Description |
string | |