Class protos.google.cloud.datacatalog.v1.Entry

Represents an Entry.

Package

@google-cloud/datacatalog!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datacatalog.v1.IEntry);

Constructs a new Entry.

Parameter

Type	Name	Description
IEntry	properties	Properties to set

Properties

bigqueryDateShardedSpec

public bigqueryDateShardedSpec?: (google.cloud.datacatalog.v1.IBigQueryDateShardedSpec|null);

Entry bigqueryDateShardedSpec.

Property Value

Type	Description
(google.cloud.datacatalog.v1.IBigQueryDateShardedSpec\|null)

bigqueryTableSpec

public bigqueryTableSpec?: (google.cloud.datacatalog.v1.IBigQueryTableSpec|null);

Entry bigqueryTableSpec.

Property Value

Type	Description
(google.cloud.datacatalog.v1.IBigQueryTableSpec\|null)

databaseTableSpec

public databaseTableSpec?: (google.cloud.datacatalog.v1.IDatabaseTableSpec|null);

Entry databaseTableSpec.

Property Value

Type	Description
(google.cloud.datacatalog.v1.IDatabaseTableSpec\|null)

dataSource

public dataSource?: (google.cloud.datacatalog.v1.IDataSource|null);

Entry dataSource.

Property Value

Type	Description
(google.cloud.datacatalog.v1.IDataSource\|null)

description

public description: string;

Entry description.

Property Value

Type	Description
string

displayName

public displayName: string;

Entry displayName.

Property Value

Type	Description
string

entryType

public entryType?: ("type"|"userSpecifiedType");

Entry entryType.

Property Value

Type	Description
("type"\|"userSpecifiedType")

fullyQualifiedName

public fullyQualifiedName: string;

Entry fullyQualifiedName.

Property Value

Type	Description
string

gcsFilesetSpec

public gcsFilesetSpec?: (google.cloud.datacatalog.v1.IGcsFilesetSpec|null);

Entry gcsFilesetSpec.

Property Value

Type	Description
(google.cloud.datacatalog.v1.IGcsFilesetSpec\|null)

integratedSystem

public integratedSystem?: (google.cloud.datacatalog.v1.IntegratedSystem|keyof typeof google.cloud.datacatalog.v1.IntegratedSystem|null);

Entry integratedSystem.

Property Value

Type	Description
(google.cloud.datacatalog.v1.IntegratedSystem\|keyof typeof google.cloud.datacatalog.v1.IntegratedSystem\|null)

linkedResource

public linkedResource: string;

Entry linkedResource.

Property Value

Type	Description
string

name

public name: string;

Entry name.

Property Value

Type	Description
string

schema

public schema?: (google.cloud.datacatalog.v1.ISchema|null);

Entry schema.

Property Value

Type	Description
(google.cloud.datacatalog.v1.ISchema\|null)

sourceSystemTimestamps

public sourceSystemTimestamps?: (google.cloud.datacatalog.v1.ISystemTimestamps|null);

Entry sourceSystemTimestamps.

Property Value

Type	Description
(google.cloud.datacatalog.v1.ISystemTimestamps\|null)

spec

public spec?: "databaseTableSpec";

Entry spec.

Property Value

Type	Description
"databaseTableSpec"

system

public system?: ("integratedSystem"|"userSpecifiedSystem");

Entry system.

Property Value

Type	Description
("integratedSystem"\|"userSpecifiedSystem")

type

public type?: (google.cloud.datacatalog.v1.EntryType|keyof typeof google.cloud.datacatalog.v1.EntryType|null);

Entry type.

Property Value

Type	Description
(google.cloud.datacatalog.v1.EntryType\|keyof typeof google.cloud.datacatalog.v1.EntryType\|null)

typeSpec

public typeSpec?: ("gcsFilesetSpec"|"bigqueryTableSpec"|"bigqueryDateShardedSpec");

Entry typeSpec.

Property Value

Type	Description
("gcsFilesetSpec"\|"bigqueryTableSpec"\|"bigqueryDateShardedSpec")

userSpecifiedSystem

public userSpecifiedSystem?: (string|null);

Entry userSpecifiedSystem.

Property Value

Type	Description
(string\|null)

userSpecifiedType

public userSpecifiedType?: (string|null);

Entry userSpecifiedType.

Property Value

Type	Description
(string\|null)

Methods

create(properties)

public static create(properties?: google.cloud.datacatalog.v1.IEntry): google.cloud.datacatalog.v1.Entry;

Creates a new Entry instance using the specified properties.

Parameter

Type	Name	Description
IEntry	properties	Properties to set

Returns

Type	Description
google.cloud.datacatalog.v1.Entry	Entry instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datacatalog.v1.Entry;

Decodes an Entry message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.cloud.datacatalog.v1.Entry	Entry

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datacatalog.v1.Entry;

Decodes an Entry message from the specified reader or buffer, length delimited.

Parameter

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.cloud.datacatalog.v1.Entry	Entry

encode(message, writer)

public static encode(message: google.cloud.datacatalog.v1.IEntry, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Entry message. Does not implicitly messages.

Parameters

Type	Name	Description
IEntry	message	Entry message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datacatalog.v1.IEntry, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
IEntry	message	Entry message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datacatalog.v1.Entry;

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.cloud.datacatalog.v1.Entry	Entry

toJSON()

public toJSON(): { [k: string]: any };

Converts this Entry to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.datacatalog.v1.Entry, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Type	Name	Description
google.cloud.datacatalog.v1.Entry	message	Entry
$protobuf.IConversionOptions	options	Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Entry message.

Parameter

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not