Class protos.google.cloud.redis.v1beta1.Instance (2.2.6)

Represents an Instance.

Package

@google-cloud/redis!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.redis.v1beta1.IInstance);

Constructs a new Instance.

Parameter

Name	Description
properties	`IInstance` Properties to set

Properties

alternativeLocationId

public alternativeLocationId: string;

Instance alternativeLocationId.

Property Value

Type	Description
string

authorizedNetwork

public authorizedNetwork: string;

Instance authorizedNetwork.

Property Value

Type	Description
string

connectMode

public connectMode: (google.cloud.redis.v1beta1.Instance.ConnectMode|keyof typeof google.cloud.redis.v1beta1.Instance.ConnectMode);

Instance connectMode.

Property Value

Type	Description
(google.cloud.redis.v1beta1.Instance.ConnectMode\|keyof typeof google.cloud.redis.v1beta1.Instance.ConnectMode)

createTime

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

Instance createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

currentLocationId

public currentLocationId: string;

Instance currentLocationId.

Property Value

Type	Description
string

displayName

public displayName: string;

Instance displayName.

Property Value

Type	Description
string

host

public host: string;

Instance host.

Property Value

Type	Description
string

labels

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

Instance labels.

Property Value

Type	Description
{ [k: string]: string }

locationId

public locationId: string;

Instance locationId.

Property Value

Type	Description
string

memorySizeGb

public memorySizeGb: number;

Instance memorySizeGb.

Property Value

Type	Description
number

name

public name: string;

Instance name.

Property Value

Type	Description
string

persistenceIamIdentity

public persistenceIamIdentity: string;

Instance persistenceIamIdentity.

Property Value

Type	Description
string

port

public port: number;

Instance port.

Property Value

Type	Description
number

redisConfigs

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

Instance redisConfigs.

Property Value

Type	Description
{ [k: string]: string }

redisVersion

public redisVersion: string;

Instance redisVersion.

Property Value

Type	Description
string

reservedIpRange

public reservedIpRange: string;

Instance reservedIpRange.

Property Value

Type	Description
string

state

public state: (google.cloud.redis.v1beta1.Instance.State|keyof typeof google.cloud.redis.v1beta1.Instance.State);

Instance state.

Property Value

Type	Description
(google.cloud.redis.v1beta1.Instance.State\|keyof typeof google.cloud.redis.v1beta1.Instance.State)

statusMessage

public statusMessage: string;

Instance statusMessage.

Property Value

Type	Description
string

tier

public tier: (google.cloud.redis.v1beta1.Instance.Tier|keyof typeof google.cloud.redis.v1beta1.Instance.Tier);

Instance tier.

Property Value

Type	Description
(google.cloud.redis.v1beta1.Instance.Tier\|keyof typeof google.cloud.redis.v1beta1.Instance.Tier)

Methods

create(properties)

public static create(properties?: google.cloud.redis.v1beta1.IInstance): google.cloud.redis.v1beta1.Instance;

Creates a new Instance instance using the specified properties.

Parameter

Name	Description
properties	`IInstance` Properties to set

Returns

Type	Description
google.cloud.redis.v1beta1.Instance	Instance instance

decode(reader, length)

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

Decodes an Instance message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.redis.v1beta1.Instance	Instance

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.redis.v1beta1.Instance;

Decodes an Instance message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.redis.v1beta1.Instance	Instance

encode(message, writer)

public static encode(message: google.cloud.redis.v1beta1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Instance message. Does not implicitly messages.

Parameters

Name	Description
message	`IInstance` Instance 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.v1beta1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IInstance` Instance 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.v1beta1.Instance;

Creates an Instance 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
google.cloud.redis.v1beta1.Instance	Instance

toJSON()

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

Converts this Instance to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.redis.v1beta1.Instance` Instance
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 an Instance 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