PhysicalSchema

google.cloud.datacatalog.v1. PhysicalSchema

Represents a PhysicalSchema.

Constructor

new PhysicalSchema(propertiesopt)

Constructs a new PhysicalSchema.

Parameters:
Name Type Attributes Description
properties google.cloud.datacatalog.v1.IPhysicalSchema <optional>

Properties to set

Implements:
  • IPhysicalSchema

Classes

AvroSchema
CsvSchema
OrcSchema
ParquetSchema
ProtobufSchema
ThriftSchema

Members

avro

PhysicalSchema avro.

csv

PhysicalSchema csv.

orc

PhysicalSchema orc.

parquet

PhysicalSchema parquet.

protobuf

PhysicalSchema protobuf.

schema

PhysicalSchema schema.

thrift

PhysicalSchema thrift.

Methods

toJSON() → {Object.<string, *>}

Converts this PhysicalSchema to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.datacatalog.v1.PhysicalSchema}

Creates a new PhysicalSchema instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.datacatalog.v1.IPhysicalSchema <optional>

Properties to set

Returns:
Type Description
google.cloud.datacatalog.v1.PhysicalSchema

PhysicalSchema instance

(static) decode(reader, lengthopt) → {google.cloud.datacatalog.v1.PhysicalSchema}

Decodes a PhysicalSchema message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.datacatalog.v1.PhysicalSchema

PhysicalSchema

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.datacatalog.v1.PhysicalSchema}

Decodes a PhysicalSchema message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.datacatalog.v1.PhysicalSchema

PhysicalSchema

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified PhysicalSchema message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.datacatalog.v1.IPhysicalSchema

PhysicalSchema message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified PhysicalSchema message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.datacatalog.v1.IPhysicalSchema

PhysicalSchema message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.datacatalog.v1.PhysicalSchema}

Creates a PhysicalSchema message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.datacatalog.v1.PhysicalSchema

PhysicalSchema

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for PhysicalSchema

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a PhysicalSchema message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.datacatalog.v1.PhysicalSchema

PhysicalSchema

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a PhysicalSchema message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not