Class protos.google.cloud.redis.cluster.v1.PscAutoConnection (0.8.0)

Represents a PscAutoConnection.

Package

@google-cloud/redis-cluster

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.redis.cluster.v1.IPscAutoConnection);

Constructs a new PscAutoConnection.

Parameter
Name Description
properties IPscAutoConnection

Properties to set

Properties

address

public address: string;

PscAutoConnection address.

connectionType

public connectionType: (google.cloud.redis.cluster.v1.ConnectionType|keyof typeof google.cloud.redis.cluster.v1.ConnectionType);

PscAutoConnection connectionType.

forwardingRule

public forwardingRule: string;

PscAutoConnection forwardingRule.

network

public network: string;

PscAutoConnection network.

projectId

public projectId: string;

PscAutoConnection projectId.

pscConnectionId

public pscConnectionId: string;

PscAutoConnection pscConnectionId.

pscConnectionStatus

public pscConnectionStatus: (google.cloud.redis.cluster.v1.PscConnectionStatus|keyof typeof google.cloud.redis.cluster.v1.PscConnectionStatus);

PscAutoConnection pscConnectionStatus.

serviceAttachment

public serviceAttachment: string;

PscAutoConnection serviceAttachment.

Methods

create(properties)

public static create(properties?: google.cloud.redis.cluster.v1.IPscAutoConnection): google.cloud.redis.cluster.v1.PscAutoConnection;

Creates a new PscAutoConnection instance using the specified properties.

Parameter
Name Description
properties IPscAutoConnection

Properties to set

Returns
Type Description
PscAutoConnection

PscAutoConnection instance

decode(reader, length)

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

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

PscAutoConnection

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.redis.cluster.v1.PscAutoConnection;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PscAutoConnection

PscAutoConnection

encode(message, writer)

public static encode(message: google.cloud.redis.cluster.v1.IPscAutoConnection, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PscAutoConnection message. Does not implicitly messages.

Parameters
Name Description
message IPscAutoConnection

PscAutoConnection 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.redis.cluster.v1.IPscAutoConnection, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPscAutoConnection

PscAutoConnection 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.redis.cluster.v1.PscAutoConnection;

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

PscAutoConnection

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PscAutoConnection

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message PscAutoConnection

PscAutoConnection

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