Represents a DiscoveryEvent.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.IDiscoveryEvent);Constructs a new DiscoveryEvent.
| Parameter | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Name | Description |
properties |
IDiscoveryEvent
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IDiscoveryEvent
DiscoveryEvent 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.dataplex.v1.IDiscoveryEvent, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DiscoveryEvent message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDiscoveryEvent
DiscoveryEvent 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.dataplex.v1.DiscoveryEvent;Creates a DiscoveryEvent 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 |
google.cloud.dataplex.v1.DiscoveryEvent | DiscoveryEvent |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DiscoveryEvent
| 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 DiscoveryEvent to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
google.cloud.dataplex.v1.DiscoveryEvent
DiscoveryEvent |
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 a DiscoveryEvent message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|