@google-cloud/memorystore
Version:
Memorystore API client for Node.js
940 lines (758 loc) • 688 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 memorystore. */
namespace memorystore {
/** Namespace v1. */
namespace v1 {
/** Represents a Memorystore */
class Memorystore extends $protobuf.rpc.Service {
/**
* Constructs a new Memorystore 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 Memorystore 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): Memorystore;
/**
* 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.memorystore.v1.IListInstancesRequest, callback: google.cloud.memorystore.v1.Memorystore.ListInstancesCallback): void;
/**
* Calls ListInstances.
* @param request ListInstancesRequest message or plain object
* @returns Promise
*/
public listInstances(request: google.cloud.memorystore.v1.IListInstancesRequest): Promise<google.cloud.memorystore.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.memorystore.v1.IGetInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.GetInstanceCallback): void;
/**
* Calls GetInstance.
* @param request GetInstanceRequest message or plain object
* @returns Promise
*/
public getInstance(request: google.cloud.memorystore.v1.IGetInstanceRequest): Promise<google.cloud.memorystore.v1.Instance>;
/**
* 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.memorystore.v1.ICreateInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.CreateInstanceCallback): void;
/**
* Calls CreateInstance.
* @param request CreateInstanceRequest message or plain object
* @returns Promise
*/
public createInstance(request: google.cloud.memorystore.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.memorystore.v1.IUpdateInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.UpdateInstanceCallback): void;
/**
* Calls UpdateInstance.
* @param request UpdateInstanceRequest message or plain object
* @returns Promise
*/
public updateInstance(request: google.cloud.memorystore.v1.IUpdateInstanceRequest): 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.memorystore.v1.IDeleteInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.DeleteInstanceCallback): void;
/**
* Calls DeleteInstance.
* @param request DeleteInstanceRequest message or plain object
* @returns Promise
*/
public deleteInstance(request: google.cloud.memorystore.v1.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;
/**
* Calls GetCertificateAuthority.
* @param request GetCertificateAuthorityRequest message or plain object
* @param callback Node-style callback called with the error, if any, and CertificateAuthority
*/
public getCertificateAuthority(request: google.cloud.memorystore.v1.IGetCertificateAuthorityRequest, callback: google.cloud.memorystore.v1.Memorystore.GetCertificateAuthorityCallback): void;
/**
* Calls GetCertificateAuthority.
* @param request GetCertificateAuthorityRequest message or plain object
* @returns Promise
*/
public getCertificateAuthority(request: google.cloud.memorystore.v1.IGetCertificateAuthorityRequest): Promise<google.cloud.memorystore.v1.CertificateAuthority>;
}
namespace Memorystore {
/**
* Callback as used by {@link google.cloud.memorystore.v1.Memorystore|listInstances}.
* @param error Error, if any
* @param [response] ListInstancesResponse
*/
type ListInstancesCallback = (error: (Error|null), response?: google.cloud.memorystore.v1.ListInstancesResponse) => void;
/**
* Callback as used by {@link google.cloud.memorystore.v1.Memorystore|getInstance}.
* @param error Error, if any
* @param [response] Instance
*/
type GetInstanceCallback = (error: (Error|null), response?: google.cloud.memorystore.v1.Instance) => void;
/**
* Callback as used by {@link google.cloud.memorystore.v1.Memorystore|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.memorystore.v1.Memorystore|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.memorystore.v1.Memorystore|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.memorystore.v1.Memorystore|getCertificateAuthority}.
* @param error Error, if any
* @param [response] CertificateAuthority
*/
type GetCertificateAuthorityCallback = (error: (Error|null), response?: google.cloud.memorystore.v1.CertificateAuthority) => void;
}
/** PscConnectionStatus enum. */
enum PscConnectionStatus {
PSC_CONNECTION_STATUS_UNSPECIFIED = 0,
ACTIVE = 1,
NOT_FOUND = 2
}
/** ConnectionType enum. */
enum ConnectionType {
CONNECTION_TYPE_UNSPECIFIED = 0,
CONNECTION_TYPE_DISCOVERY = 1,
CONNECTION_TYPE_PRIMARY = 2,
CONNECTION_TYPE_READER = 3
}
/** Properties of an Instance. */
interface IInstance {
/** Instance name */
name?: (string|null);
/** Instance createTime */
createTime?: (google.protobuf.ITimestamp|null);
/** Instance updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** Instance labels */
labels?: ({ [k: string]: string }|null);
/** Instance state */
state?: (google.cloud.memorystore.v1.Instance.State|keyof typeof google.cloud.memorystore.v1.Instance.State|null);
/** Instance stateInfo */
stateInfo?: (google.cloud.memorystore.v1.Instance.IStateInfo|null);
/** Instance uid */
uid?: (string|null);
/** Instance replicaCount */
replicaCount?: (number|null);
/** Instance authorizationMode */
authorizationMode?: (google.cloud.memorystore.v1.Instance.AuthorizationMode|keyof typeof google.cloud.memorystore.v1.Instance.AuthorizationMode|null);
/** Instance transitEncryptionMode */
transitEncryptionMode?: (google.cloud.memorystore.v1.Instance.TransitEncryptionMode|keyof typeof google.cloud.memorystore.v1.Instance.TransitEncryptionMode|null);
/** Instance shardCount */
shardCount?: (number|null);
/** Instance discoveryEndpoints */
discoveryEndpoints?: (google.cloud.memorystore.v1.IDiscoveryEndpoint[]|null);
/** Instance nodeType */
nodeType?: (google.cloud.memorystore.v1.Instance.NodeType|keyof typeof google.cloud.memorystore.v1.Instance.NodeType|null);
/** Instance persistenceConfig */
persistenceConfig?: (google.cloud.memorystore.v1.IPersistenceConfig|null);
/** Instance engineVersion */
engineVersion?: (string|null);
/** Instance engineConfigs */
engineConfigs?: ({ [k: string]: string }|null);
/** Instance nodeConfig */
nodeConfig?: (google.cloud.memorystore.v1.INodeConfig|null);
/** Instance zoneDistributionConfig */
zoneDistributionConfig?: (google.cloud.memorystore.v1.IZoneDistributionConfig|null);
/** Instance deletionProtectionEnabled */
deletionProtectionEnabled?: (boolean|null);
/** Instance pscAutoConnections */
pscAutoConnections?: (google.cloud.memorystore.v1.IPscAutoConnection[]|null);
/** Instance endpoints */
endpoints?: (google.cloud.memorystore.v1.Instance.IInstanceEndpoint[]|null);
/** Instance mode */
mode?: (google.cloud.memorystore.v1.Instance.Mode|keyof typeof google.cloud.memorystore.v1.Instance.Mode|null);
}
/** Represents an Instance. */
class Instance implements IInstance {
/**
* Constructs a new Instance.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.memorystore.v1.IInstance);
/** Instance name. */
public name: string;
/** Instance createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** Instance updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** Instance labels. */
public labels: { [k: string]: string };
/** Instance state. */
public state: (google.cloud.memorystore.v1.Instance.State|keyof typeof google.cloud.memorystore.v1.Instance.State);
/** Instance stateInfo. */
public stateInfo?: (google.cloud.memorystore.v1.Instance.IStateInfo|null);
/** Instance uid. */
public uid: string;
/** Instance replicaCount. */
public replicaCount?: (number|null);
/** Instance authorizationMode. */
public authorizationMode: (google.cloud.memorystore.v1.Instance.AuthorizationMode|keyof typeof google.cloud.memorystore.v1.Instance.AuthorizationMode);
/** Instance transitEncryptionMode. */
public transitEncryptionMode: (google.cloud.memorystore.v1.Instance.TransitEncryptionMode|keyof typeof google.cloud.memorystore.v1.Instance.TransitEncryptionMode);
/** Instance shardCount. */
public shardCount: number;
/** Instance discoveryEndpoints. */
public discoveryEndpoints: google.cloud.memorystore.v1.IDiscoveryEndpoint[];
/** Instance nodeType. */
public nodeType: (google.cloud.memorystore.v1.Instance.NodeType|keyof typeof google.cloud.memorystore.v1.Instance.NodeType);
/** Instance persistenceConfig. */
public persistenceConfig?: (google.cloud.memorystore.v1.IPersistenceConfig|null);
/** Instance engineVersion. */
public engineVersion: string;
/** Instance engineConfigs. */
public engineConfigs: { [k: string]: string };
/** Instance nodeConfig. */
public nodeConfig?: (google.cloud.memorystore.v1.INodeConfig|null);
/** Instance zoneDistributionConfig. */
public zoneDistributionConfig?: (google.cloud.memorystore.v1.IZoneDistributionConfig|null);
/** Instance deletionProtectionEnabled. */
public deletionProtectionEnabled?: (boolean|null);
/** Instance pscAutoConnections. */
public pscAutoConnections: google.cloud.memorystore.v1.IPscAutoConnection[];
/** Instance endpoints. */
public endpoints: google.cloud.memorystore.v1.Instance.IInstanceEndpoint[];
/** Instance mode. */
public mode: (google.cloud.memorystore.v1.Instance.Mode|keyof typeof google.cloud.memorystore.v1.Instance.Mode);
/** Instance _replicaCount. */
public _replicaCount?: "replicaCount";
/** Instance _deletionProtectionEnabled. */
public _deletionProtectionEnabled?: "deletionProtectionEnabled";
/**
* Creates a new Instance instance using the specified properties.
* @param [properties] Properties to set
* @returns Instance instance
*/
public static create(properties?: google.cloud.memorystore.v1.IInstance): google.cloud.memorystore.v1.Instance;
/**
* Encodes the specified Instance message. Does not implicitly {@link google.cloud.memorystore.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.memorystore.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Instance message, length delimited. Does not implicitly {@link google.cloud.memorystore.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.memorystore.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.memorystore.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.memorystore.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.memorystore.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.memorystore.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 {
/** Properties of a StateInfo. */
interface IStateInfo {
/** StateInfo updateInfo */
updateInfo?: (google.cloud.memorystore.v1.Instance.StateInfo.IUpdateInfo|null);
}
/** Represents a StateInfo. */
class StateInfo implements IStateInfo {
/**
* Constructs a new StateInfo.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.memorystore.v1.Instance.IStateInfo);
/** StateInfo updateInfo. */
public updateInfo?: (google.cloud.memorystore.v1.Instance.StateInfo.IUpdateInfo|null);
/** StateInfo info. */
public info?: "updateInfo";
/**
* Creates a new StateInfo instance using the specified properties.
* @param [properties] Properties to set
* @returns StateInfo instance
*/
public static create(properties?: google.cloud.memorystore.v1.Instance.IStateInfo): google.cloud.memorystore.v1.Instance.StateInfo;
/**
* Encodes the specified StateInfo message. Does not implicitly {@link google.cloud.memorystore.v1.Instance.StateInfo.verify|verify} messages.
* @param message StateInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.memorystore.v1.Instance.IStateInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified StateInfo message, length delimited. Does not implicitly {@link google.cloud.memorystore.v1.Instance.StateInfo.verify|verify} messages.
* @param message StateInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.memorystore.v1.Instance.IStateInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a StateInfo message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns StateInfo
* @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.memorystore.v1.Instance.StateInfo;
/**
* Decodes a StateInfo message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns StateInfo
* @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.memorystore.v1.Instance.StateInfo;
/**
* Verifies a StateInfo 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 StateInfo message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns StateInfo
*/
public static fromObject(object: { [k: string]: any }): google.cloud.memorystore.v1.Instance.StateInfo;
/**
* Creates a plain object from a StateInfo message. Also converts values to other types if specified.
* @param message StateInfo
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.memorystore.v1.Instance.StateInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this StateInfo to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for StateInfo
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace StateInfo {
/** Properties of an UpdateInfo. */
interface IUpdateInfo {
/** UpdateInfo targetShardCount */
targetShardCount?: (number|null);
/** UpdateInfo targetReplicaCount */
targetReplicaCount?: (number|null);
}
/** Represents an UpdateInfo. */
class UpdateInfo implements IUpdateInfo {
/**
* Constructs a new UpdateInfo.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.memorystore.v1.Instance.StateInfo.IUpdateInfo);
/** UpdateInfo targetShardCount. */
public targetShardCount?: (number|null);
/** UpdateInfo targetReplicaCount. */
public targetReplicaCount?: (number|null);
/** UpdateInfo _targetShardCount. */
public _targetShardCount?: "targetShardCount";
/** UpdateInfo _targetReplicaCount. */
public _targetReplicaCount?: "targetReplicaCount";
/**
* Creates a new UpdateInfo instance using the specified properties.
* @param [properties] Properties to set
* @returns UpdateInfo instance
*/
public static create(properties?: google.cloud.memorystore.v1.Instance.StateInfo.IUpdateInfo): google.cloud.memorystore.v1.Instance.StateInfo.UpdateInfo;
/**
* Encodes the specified UpdateInfo message. Does not implicitly {@link google.cloud.memorystore.v1.Instance.StateInfo.UpdateInfo.verify|verify} messages.
* @param message UpdateInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.memorystore.v1.Instance.StateInfo.IUpdateInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UpdateInfo message, length delimited. Does not implicitly {@link google.cloud.memorystore.v1.Instance.StateInfo.UpdateInfo.verify|verify} messages.
* @param message UpdateInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.memorystore.v1.Instance.StateInfo.IUpdateInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an UpdateInfo message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UpdateInfo
* @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.memorystore.v1.Instance.StateInfo.UpdateInfo;
/**
* Decodes an UpdateInfo message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UpdateInfo
* @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.memorystore.v1.Instance.StateInfo.UpdateInfo;
/**
* Verifies an UpdateInfo 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 UpdateInfo message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UpdateInfo
*/
public static fromObject(object: { [k: string]: any }): google.cloud.memorystore.v1.Instance.StateInfo.UpdateInfo;
/**
* Creates a plain object from an UpdateInfo message. Also converts values to other types if specified.
* @param message UpdateInfo
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.memorystore.v1.Instance.StateInfo.UpdateInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this UpdateInfo to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for UpdateInfo
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
}
/** Properties of an InstanceEndpoint. */
interface IInstanceEndpoint {
/** InstanceEndpoint connections */
connections?: (google.cloud.memorystore.v1.Instance.IConnectionDetail[]|null);
}
/** Represents an InstanceEndpoint. */
class InstanceEndpoint implements IInstanceEndpoint {
/**
* Constructs a new InstanceEndpoint.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.memorystore.v1.Instance.IInstanceEndpoint);
/** InstanceEndpoint connections. */
public connections: google.cloud.memorystore.v1.Instance.IConnectionDetail[];
/**
* Creates a new InstanceEndpoint instance using the specified properties.
* @param [properties] Properties to set
* @returns InstanceEndpoint instance
*/
public static create(properties?: google.cloud.memorystore.v1.Instance.IInstanceEndpoint): google.cloud.memorystore.v1.Instance.InstanceEndpoint;
/**
* Encodes the specified InstanceEndpoint message. Does not implicitly {@link google.cloud.memorystore.v1.Instance.InstanceEndpoint.verify|verify} messages.
* @param message InstanceEndpoint message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.memorystore.v1.Instance.IInstanceEndpoint, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified InstanceEndpoint message, length delimited. Does not implicitly {@link google.cloud.memorystore.v1.Instance.InstanceEndpoint.verify|verify} messages.
* @param message InstanceEndpoint message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.memorystore.v1.Instance.IInstanceEndpoint, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an InstanceEndpoint message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns InstanceEndpoint
* @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.memorystore.v1.Instance.InstanceEndpoint;
/**
* Decodes an InstanceEndpoint message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns InstanceEndpoint
* @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.memorystore.v1.Instance.InstanceEndpoint;
/**
* Verifies an InstanceEndpoint 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 InstanceEndpoint message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns InstanceEndpoint
*/
public static fromObject(object: { [k: string]: any }): google.cloud.memorystore.v1.Instance.InstanceEndpoint;
/**
* Creates a plain object from an InstanceEndpoint message. Also converts values to other types if specified.
* @param message InstanceEndpoint
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.memorystore.v1.Instance.InstanceEndpoint, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this InstanceEndpoint to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for InstanceEndpoint
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ConnectionDetail. */
interface IConnectionDetail {
/** ConnectionDetail pscAutoConnection */
pscAutoConnection?: (google.cloud.memorystore.v1.IPscAutoConnection|null);
/** ConnectionDetail pscConnection */
pscConnection?: (google.cloud.memorystore.v1.IPscConnection|null);
}
/** Represents a ConnectionDetail. */
class ConnectionDetail implements IConnectionDetail {
/**
* Constructs a new ConnectionDetail.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.memorystore.v1.Instance.IConnectionDetail);
/** ConnectionDetail pscAutoConnection. */
public pscAutoConnection?: (google.cloud.memorystore.v1.IPscAutoConnection|null);
/** ConnectionDetail pscConnection. */
public pscConnection?: (google.cloud.memorystore.v1.IPscConnection|null);
/** ConnectionDetail connection. */
public connection?: ("pscAutoConnection"|"pscConnection");
/**
* Creates a new ConnectionDetail instance using the specified properties.
* @param [properties] Properties to set
* @returns ConnectionDetail instance
*/
public static create(properties?: google.cloud.memorystore.v1.Instance.IConnectionDetail): google.cloud.memorystore.v1.Instance.ConnectionDetail;
/**
* Encodes the specified ConnectionDetail message. Does not implicitly {@link google.cloud.memorystore.v1.Instance.ConnectionDetail.verify|verify} messages.
* @param message ConnectionDetail message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.memorystore.v1.Instance.IConnectionDetail, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ConnectionDetail message, length delimited. Does not implicitly {@link google.cloud.memorystore.v1.Instance.ConnectionDetail.verify|verify} messages.
* @param message ConnectionDetail message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.memorystore.v1.Instance.IConnectionDetail, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ConnectionDetail message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ConnectionDetail
* @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.memorystore.v1.Instance.ConnectionDetail;
/**
* Decodes a ConnectionDetail message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ConnectionDetail
* @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.memorystore.v1.Instance.ConnectionDetail;
/**
* Verifies a ConnectionDetail 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 ConnectionDetail message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ConnectionDetail
*/
public static fromObject(object: { [k: string]: any }): google.cloud.memorystore.v1.Instance.ConnectionDetail;
/**
* Creates a plain object from a ConnectionDetail message. Also converts values to other types if specified.
* @param message ConnectionDetail
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.memorystore.v1.Instance.ConnectionDetail, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ConnectionDetail to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ConnectionDetail
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** State enum. */
enum State {
STATE_UNSPECIFIED = 0,
CREATING = 1,
ACTIVE = 2,
UPDATING = 3,
DELETING = 4
}
/** AuthorizationMode enum. */
enum AuthorizationMode {
AUTHORIZATION_MODE_UNSPECIFIED = 0,
AUTH_DISABLED = 1,
IAM_AUTH = 2
}
/** TransitEncryptionMode enum. */
enum TransitEncryptionMode {
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED = 0,
TRANSIT_ENCRYPTION_DISABLED = 1,
SERVER_AUTHENTICATION = 2
}
/** NodeType enum. */
enum NodeType {
NODE_TYPE_UNSPECIFIED = 0,
SHARED_CORE_NANO = 1,
HIGHMEM_MEDIUM = 2,
HIGHMEM_XLARGE = 3,
STANDARD_SMALL = 4
}
/** Mode enum. */
enum Mode {
MODE_UNSPECIFIED = 0,
STANDALONE = 1,
CLUSTER = 2,
CLUSTER_DISABLED = 4
}
}
/** Properties of a PscAutoConnection. */
interface IPscAutoConnection {
/** PscAutoConnection port */
port?: (number|null);
/** PscAutoConnection pscConnectionId */
pscConnectionId?: (string|null);
/** PscAutoConnection ipAddress */
ipAddress?: (string|null);
/** PscAutoConnection forwardingRule */
forwardingRule?: (string|null);
/** PscAutoConnection projectId */
projectId?: (string|null);
/** PscAutoConnection network */
network?: (string|null);
/** PscAutoConnection serviceAttachment */
serviceAttachment?: (string|null);
/** PscAutoConnection pscConnectionStatus */
pscConnectionStatus?: (google.cloud.memorystore.v1.PscConnectionStatus|keyof typeof google.cloud.memorystore.v1.PscConnectionStatus|null);
/** PscAutoConnection connectionType */
connectionType?: (google.cloud.memorystore.v1.ConnectionType|keyof typeof google.cloud.memorystore.v1.ConnectionType|null);
}
/** Represents a PscAutoConnection. */
class PscAutoConnection implements IPscAutoConnection {
/**
* Constructs a new PscAutoConnection.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.memorystore.v1.IPscAutoConnection);
/** PscAutoConnection port. */
public port?: (number|null);
/** PscAutoConnection pscConnectionId. */
public pscConnectionId: string;
/** PscAutoConnection ipAddress. */
public ipAddress: string;
/** PscAutoConnection forwardingRule. */
public forwardingRule: string;
/** PscAutoConnection projectId. */
public projectId: string;
/** PscAutoConnection network. */
public network: string;
/** PscAutoConnection serviceAttachment. */