Class protos.google.cloud.bigquery.migration.v2alpha.Filter (1.0.1)

Represents a Filter.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.migration.v2alpha.IFilter);

Constructs a new Filter.

Parameter
Name	Description
`properties`	`IFilter` Properties to set

Properties

inputFileExclusionPrefixes

public inputFileExclusionPrefixes: string[];

Filter inputFileExclusionPrefixes.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.migration.v2alpha.IFilter): google.cloud.bigquery.migration.v2alpha.Filter;

Creates a new Filter instance using the specified properties.

Parameter
Name	Description
`properties`	`IFilter` Properties to set

Returns
Type	Description
`Filter`	Filter instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.migration.v2alpha.Filter;

Decodes a Filter 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
`Filter`	Filter

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.migration.v2alpha.Filter;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`Filter`	Filter

encode(message, writer)

public static encode(message: google.cloud.bigquery.migration.v2alpha.IFilter, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Filter message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IFilter` Filter 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.bigquery.migration.v2alpha.IFilter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IFilter` Filter 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.bigquery.migration.v2alpha.Filter;

Creates a Filter 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
`Filter`	Filter

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Filter

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.bigquery.migration.v2alpha.Filter, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name	Description
`message`	`Filter` Filter
`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 Filter 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