Class protos.google.cloud.dataplex.v1.Asset.DiscoverySpec (2.2.2)

Represents a DiscoverySpec.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

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

Constructs a new DiscoverySpec.

Parameter
NameDescription
properties IDiscoverySpec

Properties to set

Properties

csvOptions

public csvOptions?: (google.cloud.dataplex.v1.Asset.DiscoverySpec.ICsvOptions|null);

DiscoverySpec csvOptions.

enabled

public enabled: boolean;

DiscoverySpec enabled.

excludePatterns

public excludePatterns: string[];

DiscoverySpec excludePatterns.

includePatterns

public includePatterns: string[];

DiscoverySpec includePatterns.

jsonOptions

public jsonOptions?: (google.cloud.dataplex.v1.Asset.DiscoverySpec.IJsonOptions|null);

DiscoverySpec jsonOptions.

schedule

public schedule?: (string|null);

DiscoverySpec schedule.

trigger

public trigger?: "schedule";

DiscoverySpec trigger.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.Asset.IDiscoverySpec): google.cloud.dataplex.v1.Asset.DiscoverySpec;

Creates a new DiscoverySpec instance using the specified properties.

Parameter
NameDescription
properties IDiscoverySpec

Properties to set

Returns
TypeDescription
google.cloud.dataplex.v1.Asset.DiscoverySpec

DiscoverySpec instance

decode(reader, length)

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

Decodes a DiscoverySpec 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.Asset.DiscoverySpec

DiscoverySpec

decodeDelimited(reader)

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

Decodes a DiscoverySpec 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.Asset.DiscoverySpec

DiscoverySpec

encode(message, writer)

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

Encodes the specified DiscoverySpec message. Does not implicitly messages.

Parameters
NameDescription
message IDiscoverySpec

DiscoverySpec 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.Asset.IDiscoverySpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDiscoverySpec

DiscoverySpec 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.Asset.DiscoverySpec;

Creates a DiscoverySpec 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.Asset.DiscoverySpec

DiscoverySpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DiscoverySpec

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.dataplex.v1.Asset.DiscoverySpec

DiscoverySpec

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 DiscoverySpec 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