Class protos.google.logging.v2.BigQueryOptions (11.2.0)

Represents a BigQueryOptions.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

constructor(properties?: google.logging.v2.IBigQueryOptions);

Constructs a new BigQueryOptions.

Parameter
Name Description
properties IBigQueryOptions

Properties to set

Properties

usePartitionedTables

public usePartitionedTables: boolean;

BigQueryOptions usePartitionedTables.

usesTimestampColumnPartitioning

public usesTimestampColumnPartitioning: boolean;

BigQueryOptions usesTimestampColumnPartitioning.

Methods

create(properties)

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

Creates a new BigQueryOptions instance using the specified properties.

Parameter
Name Description
properties IBigQueryOptions

Properties to set

Returns
Type Description
BigQueryOptions

BigQueryOptions instance

decode(reader, length)

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

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

BigQueryOptions

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BigQueryOptions

BigQueryOptions

encode(message, writer)

public static encode(message: google.logging.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.logging.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.logging.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
BigQueryOptions

BigQueryOptions

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BigQueryOptions

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

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

JSON object

toObject(message, options)

public static toObject(message: google.logging.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 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