@google-cloud/redis
Version:
Google Cloud Memorystore for Redis API client for Node.js
993 lines (799 loc) • 710 kB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace cloud. */
namespace cloud {
/** Namespace redis. */
namespace redis {
/** Namespace v1. */
namespace v1 {
/** Represents a CloudRedis */
class CloudRedis extends $protobuf.rpc.Service {
/**
* Constructs a new CloudRedis service.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
*/
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
/**
* Creates new CloudRedis service using the specified rpc implementation.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
* @returns RPC service. Useful where requests and/or responses are streamed.
*/
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudRedis;
/**
* Calls ListInstances.
* @param request ListInstancesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListInstancesResponse
*/
public listInstances(request: google.cloud.redis.v1.IListInstancesRequest, callback: google.cloud.redis.v1.CloudRedis.ListInstancesCallback): void;
/**
* Calls ListInstances.
* @param request ListInstancesRequest message or plain object
* @returns Promise
*/
public listInstances(request: google.cloud.redis.v1.IListInstancesRequest): Promise<google.cloud.redis.v1.ListInstancesResponse>;
/**
* Calls GetInstance.
* @param request GetInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Instance
*/
public getInstance(request: google.cloud.redis.v1.IGetInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.GetInstanceCallback): void;
/**
* Calls GetInstance.
* @param request GetInstanceRequest message or plain object
* @returns Promise
*/
public getInstance(request: google.cloud.redis.v1.IGetInstanceRequest): Promise<google.cloud.redis.v1.Instance>;
/**
* Calls GetInstanceAuthString.
* @param request GetInstanceAuthStringRequest message or plain object
* @param callback Node-style callback called with the error, if any, and InstanceAuthString
*/
public getInstanceAuthString(request: google.cloud.redis.v1.IGetInstanceAuthStringRequest, callback: google.cloud.redis.v1.CloudRedis.GetInstanceAuthStringCallback): void;
/**
* Calls GetInstanceAuthString.
* @param request GetInstanceAuthStringRequest message or plain object
* @returns Promise
*/
public getInstanceAuthString(request: google.cloud.redis.v1.IGetInstanceAuthStringRequest): Promise<google.cloud.redis.v1.InstanceAuthString>;
/**
* Calls CreateInstance.
* @param request CreateInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public createInstance(request: google.cloud.redis.v1.ICreateInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.CreateInstanceCallback): void;
/**
* Calls CreateInstance.
* @param request CreateInstanceRequest message or plain object
* @returns Promise
*/
public createInstance(request: google.cloud.redis.v1.ICreateInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls UpdateInstance.
* @param request UpdateInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public updateInstance(request: google.cloud.redis.v1.IUpdateInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.UpdateInstanceCallback): void;
/**
* Calls UpdateInstance.
* @param request UpdateInstanceRequest message or plain object
* @returns Promise
*/
public updateInstance(request: google.cloud.redis.v1.IUpdateInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls UpgradeInstance.
* @param request UpgradeInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public upgradeInstance(request: google.cloud.redis.v1.IUpgradeInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.UpgradeInstanceCallback): void;
/**
* Calls UpgradeInstance.
* @param request UpgradeInstanceRequest message or plain object
* @returns Promise
*/
public upgradeInstance(request: google.cloud.redis.v1.IUpgradeInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls ImportInstance.
* @param request ImportInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public importInstance(request: google.cloud.redis.v1.IImportInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.ImportInstanceCallback): void;
/**
* Calls ImportInstance.
* @param request ImportInstanceRequest message or plain object
* @returns Promise
*/
public importInstance(request: google.cloud.redis.v1.IImportInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls ExportInstance.
* @param request ExportInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public exportInstance(request: google.cloud.redis.v1.IExportInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.ExportInstanceCallback): void;
/**
* Calls ExportInstance.
* @param request ExportInstanceRequest message or plain object
* @returns Promise
*/
public exportInstance(request: google.cloud.redis.v1.IExportInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls FailoverInstance.
* @param request FailoverInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public failoverInstance(request: google.cloud.redis.v1.IFailoverInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.FailoverInstanceCallback): void;
/**
* Calls FailoverInstance.
* @param request FailoverInstanceRequest message or plain object
* @returns Promise
*/
public failoverInstance(request: google.cloud.redis.v1.IFailoverInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls DeleteInstance.
* @param request DeleteInstanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public deleteInstance(request: google.cloud.redis.v1.IDeleteInstanceRequest, callback: google.cloud.redis.v1.CloudRedis.DeleteInstanceCallback): void;
/**
* Calls DeleteInstance.
* @param request DeleteInstanceRequest message or plain object
* @returns Promise
*/
public deleteInstance(request: google.cloud.redis.v1.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls RescheduleMaintenance.
* @param request RescheduleMaintenanceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public rescheduleMaintenance(request: google.cloud.redis.v1.IRescheduleMaintenanceRequest, callback: google.cloud.redis.v1.CloudRedis.RescheduleMaintenanceCallback): void;
/**
* Calls RescheduleMaintenance.
* @param request RescheduleMaintenanceRequest message or plain object
* @returns Promise
*/
public rescheduleMaintenance(request: google.cloud.redis.v1.IRescheduleMaintenanceRequest): Promise<google.longrunning.Operation>;
}
namespace CloudRedis {
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|listInstances}.
* @param error Error, if any
* @param [response] ListInstancesResponse
*/
type ListInstancesCallback = (error: (Error|null), response?: google.cloud.redis.v1.ListInstancesResponse) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|getInstance}.
* @param error Error, if any
* @param [response] Instance
*/
type GetInstanceCallback = (error: (Error|null), response?: google.cloud.redis.v1.Instance) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|getInstanceAuthString}.
* @param error Error, if any
* @param [response] InstanceAuthString
*/
type GetInstanceAuthStringCallback = (error: (Error|null), response?: google.cloud.redis.v1.InstanceAuthString) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|createInstance}.
* @param error Error, if any
* @param [response] Operation
*/
type CreateInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|updateInstance}.
* @param error Error, if any
* @param [response] Operation
*/
type UpdateInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|upgradeInstance}.
* @param error Error, if any
* @param [response] Operation
*/
type UpgradeInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|importInstance}.
* @param error Error, if any
* @param [response] Operation
*/
type ImportInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|exportInstance}.
* @param error Error, if any
* @param [response] Operation
*/
type ExportInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|failoverInstance}.
* @param error Error, if any
* @param [response] Operation
*/
type FailoverInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|deleteInstance}.
* @param error Error, if any
* @param [response] Operation
*/
type DeleteInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.redis.v1.CloudRedis|rescheduleMaintenance}.
* @param error Error, if any
* @param [response] Operation
*/
type RescheduleMaintenanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
}
/** Properties of a NodeInfo. */
interface INodeInfo {
/** NodeInfo id */
id?: (string|null);
/** NodeInfo zone */
zone?: (string|null);
}
/** Represents a NodeInfo. */
class NodeInfo implements INodeInfo {
/**
* Constructs a new NodeInfo.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.redis.v1.INodeInfo);
/** NodeInfo id. */
public id: string;
/** NodeInfo zone. */
public zone: string;
/**
* Creates a new NodeInfo instance using the specified properties.
* @param [properties] Properties to set
* @returns NodeInfo instance
*/
public static create(properties?: google.cloud.redis.v1.INodeInfo): google.cloud.redis.v1.NodeInfo;
/**
* Encodes the specified NodeInfo message. Does not implicitly {@link google.cloud.redis.v1.NodeInfo.verify|verify} messages.
* @param message NodeInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.redis.v1.INodeInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified NodeInfo message, length delimited. Does not implicitly {@link google.cloud.redis.v1.NodeInfo.verify|verify} messages.
* @param message NodeInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.redis.v1.INodeInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a NodeInfo message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns NodeInfo
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.redis.v1.NodeInfo;
/**
* Decodes a NodeInfo message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns NodeInfo
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.redis.v1.NodeInfo;
/**
* Verifies a NodeInfo message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a NodeInfo message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns NodeInfo
*/
public static fromObject(object: { [k: string]: any }): google.cloud.redis.v1.NodeInfo;
/**
* Creates a plain object from a NodeInfo message. Also converts values to other types if specified.
* @param message NodeInfo
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.redis.v1.NodeInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this NodeInfo to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for NodeInfo
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an Instance. */
interface IInstance {
/** Instance name */
name?: (string|null);
/** Instance displayName */
displayName?: (string|null);
/** Instance labels */
labels?: ({ [k: string]: string }|null);
/** Instance locationId */
locationId?: (string|null);
/** Instance alternativeLocationId */
alternativeLocationId?: (string|null);
/** Instance redisVersion */
redisVersion?: (string|null);
/** Instance reservedIpRange */
reservedIpRange?: (string|null);
/** Instance secondaryIpRange */
secondaryIpRange?: (string|null);
/** Instance host */
host?: (string|null);
/** Instance port */
port?: (number|null);
/** Instance currentLocationId */
currentLocationId?: (string|null);
/** Instance createTime */
createTime?: (google.protobuf.ITimestamp|null);
/** Instance state */
state?: (google.cloud.redis.v1.Instance.State|keyof typeof google.cloud.redis.v1.Instance.State|null);
/** Instance statusMessage */
statusMessage?: (string|null);
/** Instance redisConfigs */
redisConfigs?: ({ [k: string]: string }|null);
/** Instance tier */
tier?: (google.cloud.redis.v1.Instance.Tier|keyof typeof google.cloud.redis.v1.Instance.Tier|null);
/** Instance memorySizeGb */
memorySizeGb?: (number|null);
/** Instance authorizedNetwork */
authorizedNetwork?: (string|null);
/** Instance persistenceIamIdentity */
persistenceIamIdentity?: (string|null);
/** Instance connectMode */
connectMode?: (google.cloud.redis.v1.Instance.ConnectMode|keyof typeof google.cloud.redis.v1.Instance.ConnectMode|null);
/** Instance authEnabled */
authEnabled?: (boolean|null);
/** Instance serverCaCerts */
serverCaCerts?: (google.cloud.redis.v1.ITlsCertificate[]|null);
/** Instance transitEncryptionMode */
transitEncryptionMode?: (google.cloud.redis.v1.Instance.TransitEncryptionMode|keyof typeof google.cloud.redis.v1.Instance.TransitEncryptionMode|null);
/** Instance maintenancePolicy */
maintenancePolicy?: (google.cloud.redis.v1.IMaintenancePolicy|null);
/** Instance maintenanceSchedule */
maintenanceSchedule?: (google.cloud.redis.v1.IMaintenanceSchedule|null);
/** Instance replicaCount */
replicaCount?: (number|null);
/** Instance nodes */
nodes?: (google.cloud.redis.v1.INodeInfo[]|null);
/** Instance readEndpoint */
readEndpoint?: (string|null);
/** Instance readEndpointPort */
readEndpointPort?: (number|null);
/** Instance readReplicasMode */
readReplicasMode?: (google.cloud.redis.v1.Instance.ReadReplicasMode|keyof typeof google.cloud.redis.v1.Instance.ReadReplicasMode|null);
/** Instance customerManagedKey */
customerManagedKey?: (string|null);
/** Instance persistenceConfig */
persistenceConfig?: (google.cloud.redis.v1.IPersistenceConfig|null);
/** Instance suspensionReasons */
suspensionReasons?: (google.cloud.redis.v1.Instance.SuspensionReason[]|null);
/** Instance maintenanceVersion */
maintenanceVersion?: (string|null);
/** Instance availableMaintenanceVersions */
availableMaintenanceVersions?: (string[]|null);
}
/** Represents an Instance. */
class Instance implements IInstance {
/**
* Constructs a new Instance.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.redis.v1.IInstance);
/** Instance name. */
public name: string;
/** Instance displayName. */
public displayName: string;
/** Instance labels. */
public labels: { [k: string]: string };
/** Instance locationId. */
public locationId: string;
/** Instance alternativeLocationId. */
public alternativeLocationId: string;
/** Instance redisVersion. */
public redisVersion: string;
/** Instance reservedIpRange. */
public reservedIpRange: string;
/** Instance secondaryIpRange. */
public secondaryIpRange: string;
/** Instance host. */
public host: string;
/** Instance port. */
public port: number;
/** Instance currentLocationId. */
public currentLocationId: string;
/** Instance createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** Instance state. */
public state: (google.cloud.redis.v1.Instance.State|keyof typeof google.cloud.redis.v1.Instance.State);
/** Instance statusMessage. */
public statusMessage: string;
/** Instance redisConfigs. */
public redisConfigs: { [k: string]: string };
/** Instance tier. */
public tier: (google.cloud.redis.v1.Instance.Tier|keyof typeof google.cloud.redis.v1.Instance.Tier);
/** Instance memorySizeGb. */
public memorySizeGb: number;
/** Instance authorizedNetwork. */
public authorizedNetwork: string;
/** Instance persistenceIamIdentity. */
public persistenceIamIdentity: string;
/** Instance connectMode. */
public connectMode: (google.cloud.redis.v1.Instance.ConnectMode|keyof typeof google.cloud.redis.v1.Instance.ConnectMode);
/** Instance authEnabled. */
public authEnabled: boolean;
/** Instance serverCaCerts. */
public serverCaCerts: google.cloud.redis.v1.ITlsCertificate[];
/** Instance transitEncryptionMode. */
public transitEncryptionMode: (google.cloud.redis.v1.Instance.TransitEncryptionMode|keyof typeof google.cloud.redis.v1.Instance.TransitEncryptionMode);
/** Instance maintenancePolicy. */
public maintenancePolicy?: (google.cloud.redis.v1.IMaintenancePolicy|null);
/** Instance maintenanceSchedule. */
public maintenanceSchedule?: (google.cloud.redis.v1.IMaintenanceSchedule|null);
/** Instance replicaCount. */
public replicaCount: number;
/** Instance nodes. */
public nodes: google.cloud.redis.v1.INodeInfo[];
/** Instance readEndpoint. */
public readEndpoint: string;
/** Instance readEndpointPort. */
public readEndpointPort: number;
/** Instance readReplicasMode. */
public readReplicasMode: (google.cloud.redis.v1.Instance.ReadReplicasMode|keyof typeof google.cloud.redis.v1.Instance.ReadReplicasMode);
/** Instance customerManagedKey. */
public customerManagedKey: string;
/** Instance persistenceConfig. */
public persistenceConfig?: (google.cloud.redis.v1.IPersistenceConfig|null);
/** Instance suspensionReasons. */
public suspensionReasons: google.cloud.redis.v1.Instance.SuspensionReason[];
/** Instance maintenanceVersion. */
public maintenanceVersion: string;
/** Instance availableMaintenanceVersions. */
public availableMaintenanceVersions: string[];
/**
* Creates a new Instance instance using the specified properties.
* @param [properties] Properties to set
* @returns Instance instance
*/
public static create(properties?: google.cloud.redis.v1.IInstance): google.cloud.redis.v1.Instance;
/**
* Encodes the specified Instance message. Does not implicitly {@link google.cloud.redis.v1.Instance.verify|verify} messages.
* @param message Instance message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.redis.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Instance message, length delimited. Does not implicitly {@link google.cloud.redis.v1.Instance.verify|verify} messages.
* @param message Instance message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.redis.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an Instance message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Instance
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.redis.v1.Instance;
/**
* Decodes an Instance message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Instance
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.redis.v1.Instance;
/**
* Verifies an Instance message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an Instance message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Instance
*/
public static fromObject(object: { [k: string]: any }): google.cloud.redis.v1.Instance;
/**
* Creates a plain object from an Instance message. Also converts values to other types if specified.
* @param message Instance
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.redis.v1.Instance, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Instance to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Instance
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace Instance {
/** State enum. */
enum State {
STATE_UNSPECIFIED = 0,
CREATING = 1,
READY = 2,
UPDATING = 3,
DELETING = 4,
REPAIRING = 5,
MAINTENANCE = 6,
IMPORTING = 8,
FAILING_OVER = 9
}
/** Tier enum. */
enum Tier {
TIER_UNSPECIFIED = 0,
BASIC = 1,
STANDARD_HA = 3
}
/** ConnectMode enum. */
enum ConnectMode {
CONNECT_MODE_UNSPECIFIED = 0,
DIRECT_PEERING = 1,
PRIVATE_SERVICE_ACCESS = 2
}
/** TransitEncryptionMode enum. */
enum TransitEncryptionMode {
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED = 0,
SERVER_AUTHENTICATION = 1,
DISABLED = 2
}
/** ReadReplicasMode enum. */
enum ReadReplicasMode {
READ_REPLICAS_MODE_UNSPECIFIED = 0,
READ_REPLICAS_DISABLED = 1,
READ_REPLICAS_ENABLED = 2
}
/** SuspensionReason enum. */
enum SuspensionReason {
SUSPENSION_REASON_UNSPECIFIED = 0,
CUSTOMER_MANAGED_KEY_ISSUE = 1
}
}
/** Properties of a PersistenceConfig. */
interface IPersistenceConfig {
/** PersistenceConfig persistenceMode */
persistenceMode?: (google.cloud.redis.v1.PersistenceConfig.PersistenceMode|keyof typeof google.cloud.redis.v1.PersistenceConfig.PersistenceMode|null);
/** PersistenceConfig rdbSnapshotPeriod */
rdbSnapshotPeriod?: (google.cloud.redis.v1.PersistenceConfig.SnapshotPeriod|keyof typeof google.cloud.redis.v1.PersistenceConfig.SnapshotPeriod|null);
/** PersistenceConfig rdbNextSnapshotTime */
rdbNextSnapshotTime?: (google.protobuf.ITimestamp|null);
/** PersistenceConfig rdbSnapshotStartTime */
rdbSnapshotStartTime?: (google.protobuf.ITimestamp|null);
}
/** Represents a PersistenceConfig. */
class PersistenceConfig implements IPersistenceConfig {
/**
* Constructs a new PersistenceConfig.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.redis.v1.IPersistenceConfig);
/** PersistenceConfig persistenceMode. */
public persistenceMode: (google.cloud.redis.v1.PersistenceConfig.PersistenceMode|keyof typeof google.cloud.redis.v1.PersistenceConfig.PersistenceMode);
/** PersistenceConfig rdbSnapshotPeriod. */
public rdbSnapshotPeriod: (google.cloud.redis.v1.PersistenceConfig.SnapshotPeriod|keyof typeof google.cloud.redis.v1.PersistenceConfig.SnapshotPeriod);
/** PersistenceConfig rdbNextSnapshotTime. */
public rdbNextSnapshotTime?: (google.protobuf.ITimestamp|null);
/** PersistenceConfig rdbSnapshotStartTime. */
public rdbSnapshotStartTime?: (google.protobuf.ITimestamp|null);
/**
* Creates a new PersistenceConfig instance using the specified properties.
* @param [properties] Properties to set
* @returns PersistenceConfig instance
*/
public static create(properties?: google.cloud.redis.v1.IPersistenceConfig): google.cloud.redis.v1.PersistenceConfig;
/**
* Encodes the specified PersistenceConfig message. Does not implicitly {@link google.cloud.redis.v1.PersistenceConfig.verify|verify} messages.
* @param message PersistenceConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.redis.v1.IPersistenceConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified PersistenceConfig message, length delimited. Does not implicitly {@link google.cloud.redis.v1.PersistenceConfig.verify|verify} messages.
* @param message PersistenceConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.redis.v1.IPersistenceConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a PersistenceConfig message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns PersistenceConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.redis.v1.PersistenceConfig;
/**
* Decodes a PersistenceConfig message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns PersistenceConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.redis.v1.PersistenceConfig;
/**
* Verifies a PersistenceConfig message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a PersistenceConfig message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns PersistenceConfig
*/
public static fromObject(object: { [k: string]: any }): google.cloud.redis.v1.PersistenceConfig;
/**
* Creates a plain object from a PersistenceConfig message. Also converts values to other types if specified.
* @param message PersistenceConfig
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.redis.v1.PersistenceConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this PersistenceConfig to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for PersistenceConfig
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace PersistenceConfig {
/** PersistenceMode enum. */
enum PersistenceMode {
PERSISTENCE_MODE_UNSPECIFIED = 0,
DISABLED = 1,
RDB = 2
}
/** SnapshotPeriod enum. */
enum SnapshotPeriod {
SNAPSHOT_PERIOD_UNSPECIFIED = 0,
ONE_HOUR = 3,
SIX_HOURS = 4,
TWELVE_HOURS = 5,
TWENTY_FOUR_HOURS = 6
}
}
/** Properties of a RescheduleMaintenanceRequest. */
interface IRescheduleMaintenanceRequest {
/** RescheduleMaintenanceRequest name */
name?: (string|null);
/** RescheduleMaintenanceRequest rescheduleType */
rescheduleType?: (google.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType|keyof typeof google.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType|null);
/** RescheduleMaintenanceRequest scheduleTime */
scheduleTime?: (google.protobuf.ITimestamp|null);
}
/** Represents a RescheduleMaintenanceRequest. */
class RescheduleMaintenanceRequest implements IRescheduleMaintenanceRequest {
/**
* Constructs a new RescheduleMaintenanceRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.redis.v1.IRescheduleMaintenanceRequest);
/** RescheduleMaintenanceRequest name. */
public name: string;
/** RescheduleMaintenanceRequest rescheduleType. */
public rescheduleType: (google.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType|keyof typeof google.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType);
/** RescheduleMaintenanceRequest scheduleTime. */
public scheduleTime?: (google.protobuf.ITimestamp|null);
/**
* Creates a new RescheduleMaintenanceRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns RescheduleMaintenanceRequest instance
*/
public static create(properties?: google.cloud.redis.v1.IRescheduleMaintenanceRequest): google.cloud.redis.v1.RescheduleMaintenanceRequest;
/**
* Encodes the specified RescheduleMaintenanceRequest message. Does not implicitly {@link google.cloud.redis.v1.RescheduleMaintenanceRequest.verify|verify} messages.
* @param message RescheduleMaintenanceRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.redis.v1.IRescheduleMaintenanceRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified RescheduleMaintenanceRequest message, length delimited. Does not implicitly {@link google.cloud.redis.v1.RescheduleMaintenanceRequest.verify|verify} messages.
* @param message RescheduleMaintenanceRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.redis.v1.IRescheduleMaintenanceRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a RescheduleMaintenanceRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns RescheduleMaintenanceRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.redis.v1.RescheduleMaintenanceRequest;
/**
* Decodes a RescheduleMaintenanceRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns RescheduleMaintenanceRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.redis.v1.RescheduleMaintenanceRequest;
/**
* Verifies a RescheduleMaintenanceRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a RescheduleMaintenanceRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns RescheduleMaintenanceRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.redis.v1.RescheduleMaintenanceRequest;
/**
* Creates a plain object from a RescheduleMaintenanceRequest message. Also converts values to other types if specified.
* @param message RescheduleMaintenanceRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.redis.v1.RescheduleMaintenanceRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this RescheduleMaintenanceRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for RescheduleMaintenanceRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace RescheduleMaintenanceRequest {
/** RescheduleType enum. */
enum RescheduleType {
RESCHEDULE_TYPE_UNSPECIFIED = 0,
IMMEDIATE = 1,
NEXT_AVAILABLE_WINDOW = 2,
SPECIFIC_TIME = 3
}
}
/** Properties of a MaintenancePolicy. */
interface IMaintenancePol