Google Cloud Dataplex V1 Client - Class StorageFormat (0.1.6)
Stay organized with collections
Save and categorize content based on your preferences.
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/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. |
getFormat
Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.Format format = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.Format format = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.CompressionFormat compression_format = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
setCompressionFormat
Optional. The compression type associated with the stored data.
If unspecified, the data is uncompressed.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.CompressionFormat compression_format = 2 [(.google.api.field_behavior) = OPTIONAL];
| 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/json
- application/{subtypes}
- text/csv
- text/
- image/{image subtype}
- video/{video subtype}
- audio/{audio subtype}
Generated from protobuf field string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
| 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/json
- application/{subtypes}
- text/csv
- text/
- image/{image subtype}
- video/{video subtype}
- audio/{audio subtype}
Generated from protobuf field string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCsv
Optional. Additional information about CSV formatted data.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\StorageFormat\CsvOptions|null |
|
hasCsv
setCsv
Optional. Additional information about CSV formatted data.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\StorageFormat\CsvOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJson
Optional. Additional information about CSV formatted data.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\StorageFormat\JsonOptions|null |
|
hasJson
setJson
Optional. Additional information about CSV formatted data.
Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\StorageFormat\JsonOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOptions
| Returns | |
|---|---|
| Type | Description |
string |
|