Class protos.google.pubsub.v1.BigQueryConfig (4.0.5)

Represents a BigQueryConfig.

Package

@google-cloud/pubsub

Constructors

(constructor)(properties)

constructor(properties?: google.pubsub.v1.IBigQueryConfig);

Constructs a new BigQueryConfig.

Parameter
NameDescription
properties IBigQueryConfig

Properties to set

Properties

dropUnknownFields

public dropUnknownFields: boolean;

BigQueryConfig dropUnknownFields.

state

public state: (google.pubsub.v1.BigQueryConfig.State|keyof typeof google.pubsub.v1.BigQueryConfig.State);

BigQueryConfig state.

table

public table: string;

BigQueryConfig table.

useTopicSchema

public useTopicSchema: boolean;

BigQueryConfig useTopicSchema.

writeMetadata

public writeMetadata: boolean;

BigQueryConfig writeMetadata.

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IBigQueryConfig): google.pubsub.v1.BigQueryConfig;

Creates a new BigQueryConfig instance using the specified properties.

Parameter
NameDescription
properties IBigQueryConfig

Properties to set

Returns
TypeDescription
BigQueryConfig

BigQueryConfig instance

decode(reader, length)

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

Decodes a BigQueryConfig message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
BigQueryConfig

BigQueryConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.BigQueryConfig;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BigQueryConfig

BigQueryConfig

encode(message, writer)

public static encode(message: google.pubsub.v1.IBigQueryConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BigQueryConfig message. Does not implicitly messages.

Parameters
NameDescription
message IBigQueryConfig

BigQueryConfig 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.pubsub.v1.IBigQueryConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBigQueryConfig

BigQueryConfig 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.pubsub.v1.BigQueryConfig;

Creates a BigQueryConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
BigQueryConfig

BigQueryConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BigQueryConfig

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BigQueryConfig

BigQueryConfig

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