Class protos.google.cloud.dataplex.v1.DiscoveryEvent (2.3.2)

Represents a DiscoveryEvent.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.IDiscoveryEvent);

Constructs a new DiscoveryEvent.

Parameter
NameDescription
properties IDiscoveryEvent

Properties to set

Properties

action

public action?: (google.cloud.dataplex.v1.DiscoveryEvent.IActionDetails|null);

DiscoveryEvent action.

assetId

public assetId: string;

DiscoveryEvent assetId.

config

public config?: (google.cloud.dataplex.v1.DiscoveryEvent.IConfigDetails|null);

DiscoveryEvent config.

dataLocation

public dataLocation: string;

DiscoveryEvent dataLocation.

details

public details?: ("config"|"entity"|"partition"|"action");

DiscoveryEvent details.

entity

public entity?: (google.cloud.dataplex.v1.DiscoveryEvent.IEntityDetails|null);

DiscoveryEvent entity.

lakeId

public lakeId: string;

DiscoveryEvent lakeId.

message

public message: string;

DiscoveryEvent message.

partition

public partition?: (google.cloud.dataplex.v1.DiscoveryEvent.IPartitionDetails|null);

DiscoveryEvent partition.

type

public type: (google.cloud.dataplex.v1.DiscoveryEvent.EventType|keyof typeof google.cloud.dataplex.v1.DiscoveryEvent.EventType);

DiscoveryEvent type.

zoneId

public zoneId: string;

DiscoveryEvent zoneId.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IDiscoveryEvent): google.cloud.dataplex.v1.DiscoveryEvent;

Creates a new DiscoveryEvent instance using the specified properties.

Parameter
NameDescription
properties IDiscoveryEvent

Properties to set

Returns
TypeDescription
google.cloud.dataplex.v1.DiscoveryEvent

DiscoveryEvent instance

decode(reader, length)

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

Decodes a DiscoveryEvent message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dataplex.v1.DiscoveryEvent

DiscoveryEvent

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dataplex.v1.DiscoveryEvent

DiscoveryEvent

encode(message, writer)

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

Encodes the specified DiscoveryEvent message. Does not implicitly messages.

Parameters
NameDescription
message IDiscoveryEvent

DiscoveryEvent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IDiscoveryEvent

DiscoveryEvent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.dataplex.v1.DiscoveryEvent

DiscoveryEvent

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DiscoveryEvent

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this DiscoveryEvent to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.dataplex.v1.DiscoveryEvent

DiscoveryEvent

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a DiscoveryEvent message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not