Class protos.google.devtools.cloudbuild.v1.PubsubConfig

Represents a PubsubConfig.

Package

@google-cloud/cloudbuild

Constructors

(constructor)(properties)

constructor(properties?: google.devtools.cloudbuild.v1.IPubsubConfig);

Constructs a new PubsubConfig.

Parameter
NameDescription
properties IPubsubConfig

Properties to set

Properties

serviceAccountEmail

public serviceAccountEmail: string;

PubsubConfig serviceAccountEmail.

state

public state: (google.devtools.cloudbuild.v1.PubsubConfig.State|keyof typeof google.devtools.cloudbuild.v1.PubsubConfig.State);

PubsubConfig state.

subscription

public subscription: string;

PubsubConfig subscription.

topic

public topic: string;

PubsubConfig topic.

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IPubsubConfig): google.devtools.cloudbuild.v1.PubsubConfig;

Creates a new PubsubConfig instance using the specified properties.

Parameter
NameDescription
properties IPubsubConfig

Properties to set

Returns
TypeDescription
google.devtools.cloudbuild.v1.PubsubConfig

PubsubConfig instance

decode(reader, length)

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

Decodes a PubsubConfig message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.devtools.cloudbuild.v1.PubsubConfig

PubsubConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devtools.cloudbuild.v1.PubsubConfig;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.devtools.cloudbuild.v1.PubsubConfig

PubsubConfig

encode(message, writer)

public static encode(message: google.devtools.cloudbuild.v1.IPubsubConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PubsubConfig message. Does not implicitly messages.

Parameters
NameDescription
message IPubsubConfig

PubsubConfig 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.devtools.cloudbuild.v1.IPubsubConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IPubsubConfig

PubsubConfig 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.devtools.cloudbuild.v1.PubsubConfig;

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

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

Plain object

Returns
TypeDescription
google.devtools.cloudbuild.v1.PubsubConfig

PubsubConfig

toJSON()

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

Converts this PubsubConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.devtools.cloudbuild.v1.PubsubConfig

PubsubConfig

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