Class protos.google.cloud.redis.v1.Instance (3.3.0)

Version latest

• 3.3.0 (latest)
• 3.2.2
• 3.1.5
• 2.4.0
• 2.3.1
• 2.2.6

Represents an Instance.

Package

@google-cloud/redis

Constructors

(constructor)(properties)

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

Constructs a new Instance.

Parameter
Name	Description
properties	IInstance Properties to set

Properties

alternativeLocationId

public alternativeLocationId: string;

Instance alternativeLocationId.

authEnabled

public authEnabled: boolean;

Instance authEnabled.

authorizedNetwork

public authorizedNetwork: string;

Instance authorizedNetwork.

availableMaintenanceVersions

public availableMaintenanceVersions: string[];

Instance availableMaintenanceVersions.

connectMode

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

Instance connectMode.

createTime

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

Instance createTime.

currentLocationId

public currentLocationId: string;

Instance currentLocationId.

customerManagedKey

public customerManagedKey: string;

Instance customerManagedKey.

displayName

public displayName: string;

Instance displayName.

host

public host: string;

Instance host.

labels

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

Instance labels.

locationId

public locationId: string;

Instance locationId.

maintenancePolicy

public maintenancePolicy?: (google.cloud.redis.v1.IMaintenancePolicy|null);

Instance maintenancePolicy.

maintenanceSchedule

public maintenanceSchedule?: (google.cloud.redis.v1.IMaintenanceSchedule|null);

Instance maintenanceSchedule.

maintenanceVersion

public maintenanceVersion: string;

Instance maintenanceVersion.

memorySizeGb

public memorySizeGb: number;

Instance memorySizeGb.

name

public name: string;

Instance name.

nodes

public nodes: google.cloud.redis.v1.INodeInfo[];

Instance nodes.

persistenceConfig

public persistenceConfig?: (google.cloud.redis.v1.IPersistenceConfig|null);

Instance persistenceConfig.

persistenceIamIdentity

public persistenceIamIdentity: string;

Instance persistenceIamIdentity.

port

public port: number;

Instance port.

readEndpoint

public readEndpoint: string;

Instance readEndpoint.

readEndpointPort

public readEndpointPort: number;

Instance readEndpointPort.

readReplicasMode

public readReplicasMode: (google.cloud.redis.v1.Instance.ReadReplicasMode|keyof typeof google.cloud.redis.v1.Instance.ReadReplicasMode);

Instance readReplicasMode.

redisConfigs

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

Instance redisConfigs.

redisVersion

public redisVersion: string;

Instance redisVersion.

replicaCount

public replicaCount: number;

Instance replicaCount.

reservedIpRange

public reservedIpRange: string;

Instance reservedIpRange.

secondaryIpRange

public secondaryIpRange: string;

Instance secondaryIpRange.

serverCaCerts

public serverCaCerts: google.cloud.redis.v1.ITlsCertificate[];

Instance serverCaCerts.

state

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

Instance state.

statusMessage

public statusMessage: string;

Instance statusMessage.

suspensionReasons

public suspensionReasons: google.cloud.redis.v1.Instance.SuspensionReason[];

Instance suspensionReasons.

tier

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

Instance tier.

transitEncryptionMode

public transitEncryptionMode: (google.cloud.redis.v1.Instance.TransitEncryptionMode|keyof typeof google.cloud.redis.v1.Instance.TransitEncryptionMode);

Instance transitEncryptionMode.

Methods

create(properties)

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

Creates a new Instance instance using the specified properties.

Parameter
Name	Description
properties	IInstance Properties to set

Returns
Type	Description
Instance	Instance instance

decode(reader, length)

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

Decodes an Instance 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
Instance	Instance

decodeDelimited(reader)

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

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

Parameter
Name	Description
reader	(Reader|Uint8Array) Reader or buffer to decode from

Returns
Type	Description
Instance	Instance

encode(message, writer)

public static encode(message: google.cloud.redis.v1.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.v1.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.v1.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
Instance	Instance

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Instance

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

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

toObject(message, options)

public static toObject(message: google.cloud.redis.v1.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	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