Class protos.google.privacy.dlp.v2.BigQueryOptions (3.4.0)

Represents a BigQueryOptions.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.privacy.dlp.v2.IBigQueryOptions);

Constructs a new BigQueryOptions.

Parameter

Name	Description
properties	`IBigQueryOptions` Properties to set

Properties

excludedFields

public excludedFields: google.privacy.dlp.v2.IFieldId[];

BigQueryOptions excludedFields.

identifyingFields

public identifyingFields: google.privacy.dlp.v2.IFieldId[];

BigQueryOptions identifyingFields.

includedFields

public includedFields: google.privacy.dlp.v2.IFieldId[];

BigQueryOptions includedFields.

rowsLimit

public rowsLimit: (number|Long|string);

BigQueryOptions rowsLimit.

rowsLimitPercent

public rowsLimitPercent: number;

BigQueryOptions rowsLimitPercent.

sampleMethod

public sampleMethod: (google.privacy.dlp.v2.BigQueryOptions.SampleMethod|keyof typeof google.privacy.dlp.v2.BigQueryOptions.SampleMethod);

BigQueryOptions sampleMethod.

tableReference

public tableReference?: (google.privacy.dlp.v2.IBigQueryTable|null);

BigQueryOptions tableReference.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IBigQueryOptions): google.privacy.dlp.v2.BigQueryOptions;

Creates a new BigQueryOptions instance using the specified properties.

Parameter

Name	Description
properties	`IBigQueryOptions` Properties to set

Returns

Type	Description
google.privacy.dlp.v2.BigQueryOptions	BigQueryOptions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.BigQueryOptions;

Decodes a BigQueryOptions 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.privacy.dlp.v2.BigQueryOptions	BigQueryOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.BigQueryOptions;

Decodes a BigQueryOptions 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.privacy.dlp.v2.BigQueryOptions	BigQueryOptions

encode(message, writer)

public static encode(message: google.privacy.dlp.v2.IBigQueryOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BigQueryOptions message. Does not implicitly messages.

Parameters

Name	Description
message	`IBigQueryOptions` BigQueryOptions 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.privacy.dlp.v2.IBigQueryOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IBigQueryOptions` BigQueryOptions 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.privacy.dlp.v2.BigQueryOptions;

Creates a BigQueryOptions 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.privacy.dlp.v2.BigQueryOptions	BigQueryOptions

toJSON()

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

Converts this BigQueryOptions to JSON.

Returns

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

toObject(message, options)

public static toObject(message: google.privacy.dlp.v2.BigQueryOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.privacy.dlp.v2.BigQueryOptions` BigQueryOptions
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 BigQueryOptions 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