Class protos.google.cloud.datacatalog.v1.FilesetSpec (4.7.0)

Represents a FilesetSpec.

Package

@google-cloud/datacatalog

Constructors

(constructor)(properties)

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

Constructs a new FilesetSpec.

Parameter
Name Description
properties IFilesetSpec

Properties to set

Properties

dataplexFileset

public dataplexFileset?: (google.cloud.datacatalog.v1.IDataplexFilesetSpec|null);

FilesetSpec dataplexFileset.

Methods

create(properties)

public static create(properties?: google.cloud.datacatalog.v1.IFilesetSpec): google.cloud.datacatalog.v1.FilesetSpec;

Creates a new FilesetSpec instance using the specified properties.

Parameter
Name Description
properties IFilesetSpec

Properties to set

Returns
Type Description
FilesetSpec

FilesetSpec instance

decode(reader, length)

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

Decodes a FilesetSpec 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
FilesetSpec

FilesetSpec

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FilesetSpec

FilesetSpec

encode(message, writer)

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

Encodes the specified FilesetSpec message. Does not implicitly messages.

Parameters
Name Description
message IFilesetSpec

FilesetSpec 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.v1.IFilesetSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFilesetSpec

FilesetSpec 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.v1.FilesetSpec;

Creates a FilesetSpec 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
FilesetSpec

FilesetSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FilesetSpec

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FilesetSpec

FilesetSpec

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