Class protos.google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource (2.2.0)

Represents a PubSubTopicSource.

Package

@google-cloud/bigquery-analyticshub

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.analyticshub.v1.Listing.IPubSubTopicSource);

Constructs a new PubSubTopicSource.

Parameter
Name Description
properties IPubSubTopicSource

Properties to set

Properties

dataAffinityRegions

public dataAffinityRegions: string[];

PubSubTopicSource dataAffinityRegions.

topic

public topic: string;

PubSubTopicSource topic.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.analyticshub.v1.Listing.IPubSubTopicSource): google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource;

Creates a new PubSubTopicSource instance using the specified properties.

Parameter
Name Description
properties IPubSubTopicSource

Properties to set

Returns
Type Description
PubSubTopicSource

PubSubTopicSource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource;

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

PubSubTopicSource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PubSubTopicSource

PubSubTopicSource

encode(message, writer)

public static encode(message: google.cloud.bigquery.analyticshub.v1.Listing.IPubSubTopicSource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PubSubTopicSource message. Does not implicitly messages.

Parameters
Name Description
message IPubSubTopicSource

PubSubTopicSource 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.analyticshub.v1.Listing.IPubSubTopicSource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPubSubTopicSource

PubSubTopicSource 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.analyticshub.v1.Listing.PubSubTopicSource;

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

PubSubTopicSource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PubSubTopicSource

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message PubSubTopicSource

PubSubTopicSource

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