Class protos.google.cloud.developerconnect.v1.Connection (0.1.0)

Represents a Connection.

Package

@google-cloud/developerconnect

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.developerconnect.v1.IConnection);

Constructs a new Connection.

Parameter
Name Description
properties IConnection

Properties to set

Properties

annotations

public annotations: { [k: string]: string };

Connection annotations.

connectionConfig

public connectionConfig?: "githubConfig";

Connection connectionConfig.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Connection createTime.

deleteTime

public deleteTime?: (google.protobuf.ITimestamp|null);

Connection deleteTime.

disabled

public disabled: boolean;

Connection disabled.

etag

public etag: string;

Connection etag.

githubConfig

public githubConfig?: (google.cloud.developerconnect.v1.IGitHubConfig|null);

Connection githubConfig.

installationState

public installationState?: (google.cloud.developerconnect.v1.IInstallationState|null);

Connection installationState.

labels

public labels: { [k: string]: string };

Connection labels.

name

public name: string;

Connection name.

reconciling

public reconciling: boolean;

Connection reconciling.

uid

public uid: string;

Connection uid.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Connection updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.developerconnect.v1.IConnection): google.cloud.developerconnect.v1.Connection;

Creates a new Connection instance using the specified properties.

Parameter
Name Description
properties IConnection

Properties to set

Returns
Type Description
Connection

Connection instance

decode(reader, length)

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

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

Connection

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.developerconnect.v1.Connection;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Connection

Connection

encode(message, writer)

public static encode(message: google.cloud.developerconnect.v1.IConnection, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Connection message. Does not implicitly messages.

Parameters
Name Description
message IConnection

Connection 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.developerconnect.v1.IConnection, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IConnection

Connection 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.developerconnect.v1.Connection;

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

Connection

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Connection

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Connection

Connection

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