Class protos.google.container.v1beta1.NotificationConfig.PubSub (5.19.0)

Represents a PubSub.

Package

@google-cloud/container

Constructors

(constructor)(properties)

constructor(properties?: google.container.v1beta1.NotificationConfig.IPubSub);

Constructs a new PubSub.

Parameter
Name Description
properties IPubSub

Properties to set

Properties

enabled

public enabled: boolean;

PubSub enabled.

filter

public filter?: (google.container.v1beta1.NotificationConfig.IFilter|null);

PubSub filter.

topic

public topic: string;

PubSub topic.

Methods

create(properties)

public static create(properties?: google.container.v1beta1.NotificationConfig.IPubSub): google.container.v1beta1.NotificationConfig.PubSub;

Creates a new PubSub instance using the specified properties.

Parameter
Name Description
properties IPubSub

Properties to set

Returns
Type Description
PubSub

PubSub instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.container.v1beta1.NotificationConfig.PubSub;

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

PubSub

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1beta1.NotificationConfig.PubSub;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PubSub

PubSub

encode(message, writer)

public static encode(message: google.container.v1beta1.NotificationConfig.IPubSub, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PubSub message. Does not implicitly messages.

Parameters
Name Description
message IPubSub

PubSub 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.container.v1beta1.NotificationConfig.IPubSub, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPubSub

PubSub 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.container.v1beta1.NotificationConfig.PubSub;

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

PubSub

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PubSub

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

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

JSON object

toObject(message, options)

public static toObject(message: google.container.v1beta1.NotificationConfig.PubSub, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message PubSub

PubSub

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