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