Represents a StorageFormat.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.IStorageFormat);Constructs a new StorageFormat.
| Parameter | |
|---|---|
| Name | Description |
properties |
IStorageFormat
Properties to set |
Properties
compressionFormat
public compressionFormat: (google.cloud.dataplex.v1.StorageFormat.CompressionFormat|keyof typeof google.cloud.dataplex.v1.StorageFormat.CompressionFormat);StorageFormat compressionFormat.
csv
public csv?: (google.cloud.dataplex.v1.StorageFormat.ICsvOptions|null);StorageFormat csv.
format
public format: (google.cloud.dataplex.v1.StorageFormat.Format|keyof typeof google.cloud.dataplex.v1.StorageFormat.Format);StorageFormat format.
iceberg
public iceberg?: (google.cloud.dataplex.v1.StorageFormat.IIcebergOptions|null);StorageFormat iceberg.
json
public json?: (google.cloud.dataplex.v1.StorageFormat.IJsonOptions|null);StorageFormat json.
mimeType
public mimeType: string;StorageFormat mimeType.
options
public options?: ("csv"|"json"|"iceberg");StorageFormat options.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.IStorageFormat): google.cloud.dataplex.v1.StorageFormat;Creates a new StorageFormat instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IStorageFormat
Properties to set |
| Returns | |
|---|---|
| Type | Description |
StorageFormat | StorageFormat instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.StorageFormat;Decodes a StorageFormat message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
StorageFormat | StorageFormat |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.StorageFormat;Decodes a StorageFormat message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
StorageFormat | StorageFormat |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.IStorageFormat, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified StorageFormat message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IStorageFormat
StorageFormat message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dataplex.v1.IStorageFormat, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified StorageFormat message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IStorageFormat
StorageFormat message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dataplex.v1.StorageFormat;Creates a StorageFormat message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
StorageFormat | StorageFormat |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for StorageFormat
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this StorageFormat to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.StorageFormat, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a StorageFormat message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
StorageFormat
StorageFormat |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a StorageFormat message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|