Constructor
new ColumnSchema(propertiesopt)
Constructs a new ColumnSchema.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.datacatalog.v1.IColumnSchema |
<optional> |
Properties to set |
- Implements:
-
- IColumnSchema
Classes
Members
column
ColumnSchema column.
defaultValue
ColumnSchema defaultValue.
description
ColumnSchema description.
gcRule
ColumnSchema gcRule.
highestIndexingType
ColumnSchema highestIndexingType.
lookerColumnSpec
ColumnSchema lookerColumnSpec.
mode
ColumnSchema mode.
ordinalPosition
ColumnSchema ordinalPosition.
rangeElementType
ColumnSchema rangeElementType.
subcolumns
ColumnSchema subcolumns.
systemSpec
ColumnSchema systemSpec.
type
ColumnSchema type.
IndexingType
IndexingType enum.
Properties:
| Name | Type | Description |
|---|---|---|
INDEXING_TYPE_UNSPECIFIED |
number |
INDEXING_TYPE_UNSPECIFIED value |
INDEXING_TYPE_NONE |
number |
INDEXING_TYPE_NONE value |
INDEXING_TYPE_NON_UNIQUE |
number |
INDEXING_TYPE_NON_UNIQUE value |
INDEXING_TYPE_UNIQUE |
number |
INDEXING_TYPE_UNIQUE value |
INDEXING_TYPE_PRIMARY_KEY |
number |
INDEXING_TYPE_PRIMARY_KEY value |
Methods
toJSON() → {Object.<string, *>}
Converts this ColumnSchema to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.datacatalog.v1.ColumnSchema}
Creates a new ColumnSchema instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.datacatalog.v1.IColumnSchema |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.datacatalog.v1.ColumnSchema |
ColumnSchema instance |
(static) decode(reader, lengthopt) → {google.cloud.datacatalog.v1.ColumnSchema}
Decodes a ColumnSchema 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.ColumnSchema |
ColumnSchema |
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.ColumnSchema}
Decodes a ColumnSchema 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.ColumnSchema |
ColumnSchema |
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 ColumnSchema message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.datacatalog.v1.IColumnSchema |
ColumnSchema 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 ColumnSchema message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.datacatalog.v1.IColumnSchema |
ColumnSchema 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.ColumnSchema}
Creates a ColumnSchema 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.ColumnSchema |
ColumnSchema |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ColumnSchema
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 ColumnSchema message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.datacatalog.v1.ColumnSchema |
ColumnSchema |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a ColumnSchema message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|