Class protos.google.cloud.datacatalog.v1beta1.Entry (4.7.0)

Represents an Entry.

Package

@google-cloud/datacatalog

Constructors

(constructor)(properties)

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

Constructs a new Entry.

Parameter
Name Description
properties IEntry

Properties to set

Properties

bigqueryDateShardedSpec

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

Entry bigqueryDateShardedSpec.

bigqueryTableSpec

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

Entry bigqueryTableSpec.

description

public description: string;

Entry description.

displayName

public displayName: string;

Entry displayName.

entryType

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

Entry entryType.

gcsFilesetSpec

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

Entry gcsFilesetSpec.

integratedSystem

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

Entry integratedSystem.

linkedResource

public linkedResource: string;

Entry linkedResource.

name

public name: string;

Entry name.

schema

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

Entry schema.

sourceSystemTimestamps

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

Entry sourceSystemTimestamps.

system

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

Entry system.

type

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

Entry type.

typeSpec

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

Entry typeSpec.

usageSignal

public usageSignal?: (google.cloud.datacatalog.v1beta1.IUsageSignal|null);

Entry usageSignal.

userSpecifiedSystem

public userSpecifiedSystem?: (string|null);

Entry userSpecifiedSystem.

userSpecifiedType

public userSpecifiedType?: (string|null);

Entry userSpecifiedType.

Methods

create(properties)

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

Creates a new Entry instance using the specified properties.

Parameter
Name Description
properties IEntry

Properties to set

Returns
Type Description
Entry

Entry instance

decode(reader, length)

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

Decodes an Entry 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
Entry

Entry

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Entry

Entry

encode(message, writer)

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

Encodes the specified Entry message. Does not implicitly messages.

Parameters
Name Description
message IEntry

Entry 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.datacatalog.v1beta1.IEntry, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEntry

Entry 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.datacatalog.v1beta1.Entry;

Creates an Entry 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
Entry

Entry

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Entry

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 Entry to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Entry

Entry

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 an Entry message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not