@google-cloud/kms
Version:
Google Cloud Key Management Service (KMS) API client for Node.js
867 lines (792 loc) • 2.98 MB
JavaScript
// 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.
/*eslint-disable block-scoped-var, id-length, no-control-regex, no-magic-numbers, no-prototype-builtins, no-redeclare, no-shadow, no-var, sort-vars*/
(function(global, factory) { /* global define, require, module */
/* AMD */ if (typeof define === 'function' && define.amd)
define(["protobufjs/minimal"], factory);
/* CommonJS */ else if (typeof require === 'function' && typeof module === 'object' && module && module.exports)
module.exports = factory(require("google-gax/build/src/protobuf").protobufMinimal);
})(this, function($protobuf) {
"use strict";
// Common aliases
var $Reader = $protobuf.Reader, $Writer = $protobuf.Writer, $util = $protobuf.util;
// Exported root namespace
var $root = $protobuf.roots._google_cloud_kms_protos || ($protobuf.roots._google_cloud_kms_protos = {});
$root.google = (function() {
/**
* Namespace google.
* @exports google
* @namespace
*/
var google = {};
google.cloud = (function() {
/**
* Namespace cloud.
* @memberof google
* @namespace
*/
var cloud = {};
cloud.kms = (function() {
/**
* Namespace kms.
* @memberof google.cloud
* @namespace
*/
var kms = {};
kms.v1 = (function() {
/**
* Namespace v1.
* @memberof google.cloud.kms
* @namespace
*/
var v1 = {};
v1.Autokey = (function() {
/**
* Constructs a new Autokey service.
* @memberof google.cloud.kms.v1
* @classdesc Represents an Autokey
* @extends $protobuf.rpc.Service
* @constructor
* @param {$protobuf.RPCImpl} rpcImpl RPC implementation
* @param {boolean} [requestDelimited=false] Whether requests are length-delimited
* @param {boolean} [responseDelimited=false] Whether responses are length-delimited
*/
function Autokey(rpcImpl, requestDelimited, responseDelimited) {
$protobuf.rpc.Service.call(this, rpcImpl, requestDelimited, responseDelimited);
}
(Autokey.prototype = Object.create($protobuf.rpc.Service.prototype)).constructor = Autokey;
/**
* Creates new Autokey service using the specified rpc implementation.
* @function create
* @memberof google.cloud.kms.v1.Autokey
* @static
* @param {$protobuf.RPCImpl} rpcImpl RPC implementation
* @param {boolean} [requestDelimited=false] Whether requests are length-delimited
* @param {boolean} [responseDelimited=false] Whether responses are length-delimited
* @returns {Autokey} RPC service. Useful where requests and/or responses are streamed.
*/
Autokey.create = function create(rpcImpl, requestDelimited, responseDelimited) {
return new this(rpcImpl, requestDelimited, responseDelimited);
};
/**
* Callback as used by {@link google.cloud.kms.v1.Autokey|createKeyHandle}.
* @memberof google.cloud.kms.v1.Autokey
* @typedef CreateKeyHandleCallback
* @type {function}
* @param {Error|null} error Error, if any
* @param {google.longrunning.Operation} [response] Operation
*/
/**
* Calls CreateKeyHandle.
* @function createKeyHandle
* @memberof google.cloud.kms.v1.Autokey
* @instance
* @param {google.cloud.kms.v1.ICreateKeyHandleRequest} request CreateKeyHandleRequest message or plain object
* @param {google.cloud.kms.v1.Autokey.CreateKeyHandleCallback} callback Node-style callback called with the error, if any, and Operation
* @returns {undefined}
* @variation 1
*/
Object.defineProperty(Autokey.prototype.createKeyHandle = function createKeyHandle(request, callback) {
return this.rpcCall(createKeyHandle, $root.google.cloud.kms.v1.CreateKeyHandleRequest, $root.google.longrunning.Operation, request, callback);
}, "name", { value: "CreateKeyHandle" });
/**
* Calls CreateKeyHandle.
* @function createKeyHandle
* @memberof google.cloud.kms.v1.Autokey
* @instance
* @param {google.cloud.kms.v1.ICreateKeyHandleRequest} request CreateKeyHandleRequest message or plain object
* @returns {Promise<google.longrunning.Operation>} Promise
* @variation 2
*/
/**
* Callback as used by {@link google.cloud.kms.v1.Autokey|getKeyHandle}.
* @memberof google.cloud.kms.v1.Autokey
* @typedef GetKeyHandleCallback
* @type {function}
* @param {Error|null} error Error, if any
* @param {google.cloud.kms.v1.KeyHandle} [response] KeyHandle
*/
/**
* Calls GetKeyHandle.
* @function getKeyHandle
* @memberof google.cloud.kms.v1.Autokey
* @instance
* @param {google.cloud.kms.v1.IGetKeyHandleRequest} request GetKeyHandleRequest message or plain object
* @param {google.cloud.kms.v1.Autokey.GetKeyHandleCallback} callback Node-style callback called with the error, if any, and KeyHandle
* @returns {undefined}
* @variation 1
*/
Object.defineProperty(Autokey.prototype.getKeyHandle = function getKeyHandle(request, callback) {
return this.rpcCall(getKeyHandle, $root.google.cloud.kms.v1.GetKeyHandleRequest, $root.google.cloud.kms.v1.KeyHandle, request, callback);
}, "name", { value: "GetKeyHandle" });
/**
* Calls GetKeyHandle.
* @function getKeyHandle
* @memberof google.cloud.kms.v1.Autokey
* @instance
* @param {google.cloud.kms.v1.IGetKeyHandleRequest} request GetKeyHandleRequest message or plain object
* @returns {Promise<google.cloud.kms.v1.KeyHandle>} Promise
* @variation 2
*/
/**
* Callback as used by {@link google.cloud.kms.v1.Autokey|listKeyHandles}.
* @memberof google.cloud.kms.v1.Autokey
* @typedef ListKeyHandlesCallback
* @type {function}
* @param {Error|null} error Error, if any
* @param {google.cloud.kms.v1.ListKeyHandlesResponse} [response] ListKeyHandlesResponse
*/
/**
* Calls ListKeyHandles.
* @function listKeyHandles
* @memberof google.cloud.kms.v1.Autokey
* @instance
* @param {google.cloud.kms.v1.IListKeyHandlesRequest} request ListKeyHandlesRequest message or plain object
* @param {google.cloud.kms.v1.Autokey.ListKeyHandlesCallback} callback Node-style callback called with the error, if any, and ListKeyHandlesResponse
* @returns {undefined}
* @variation 1
*/
Object.defineProperty(Autokey.prototype.listKeyHandles = function listKeyHandles(request, callback) {
return this.rpcCall(listKeyHandles, $root.google.cloud.kms.v1.ListKeyHandlesRequest, $root.google.cloud.kms.v1.ListKeyHandlesResponse, request, callback);
}, "name", { value: "ListKeyHandles" });
/**
* Calls ListKeyHandles.
* @function listKeyHandles
* @memberof google.cloud.kms.v1.Autokey
* @instance
* @param {google.cloud.kms.v1.IListKeyHandlesRequest} request ListKeyHandlesRequest message or plain object
* @returns {Promise<google.cloud.kms.v1.ListKeyHandlesResponse>} Promise
* @variation 2
*/
return Autokey;
})();
v1.CreateKeyHandleRequest = (function() {
/**
* Properties of a CreateKeyHandleRequest.
* @memberof google.cloud.kms.v1
* @interface ICreateKeyHandleRequest
* @property {string|null} [parent] CreateKeyHandleRequest parent
* @property {string|null} [keyHandleId] CreateKeyHandleRequest keyHandleId
* @property {google.cloud.kms.v1.IKeyHandle|null} [keyHandle] CreateKeyHandleRequest keyHandle
*/
/**
* Constructs a new CreateKeyHandleRequest.
* @memberof google.cloud.kms.v1
* @classdesc Represents a CreateKeyHandleRequest.
* @implements ICreateKeyHandleRequest
* @constructor
* @param {google.cloud.kms.v1.ICreateKeyHandleRequest=} [properties] Properties to set
*/
function CreateKeyHandleRequest(properties) {
if (properties)
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
if (properties[keys[i]] != null)
this[keys[i]] = properties[keys[i]];
}
/**
* CreateKeyHandleRequest parent.
* @member {string} parent
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @instance
*/
CreateKeyHandleRequest.prototype.parent = "";
/**
* CreateKeyHandleRequest keyHandleId.
* @member {string} keyHandleId
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @instance
*/
CreateKeyHandleRequest.prototype.keyHandleId = "";
/**
* CreateKeyHandleRequest keyHandle.
* @member {google.cloud.kms.v1.IKeyHandle|null|undefined} keyHandle
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @instance
*/
CreateKeyHandleRequest.prototype.keyHandle = null;
/**
* Creates a new CreateKeyHandleRequest instance using the specified properties.
* @function create
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.ICreateKeyHandleRequest=} [properties] Properties to set
* @returns {google.cloud.kms.v1.CreateKeyHandleRequest} CreateKeyHandleRequest instance
*/
CreateKeyHandleRequest.create = function create(properties) {
return new CreateKeyHandleRequest(properties);
};
/**
* Encodes the specified CreateKeyHandleRequest message. Does not implicitly {@link google.cloud.kms.v1.CreateKeyHandleRequest.verify|verify} messages.
* @function encode
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.ICreateKeyHandleRequest} message CreateKeyHandleRequest message or plain object to encode
* @param {$protobuf.Writer} [writer] Writer to encode to
* @returns {$protobuf.Writer} Writer
*/
CreateKeyHandleRequest.encode = function encode(message, writer) {
if (!writer)
writer = $Writer.create();
if (message.parent != null && Object.hasOwnProperty.call(message, "parent"))
writer.uint32(/* id 1, wireType 2 =*/10).string(message.parent);
if (message.keyHandleId != null && Object.hasOwnProperty.call(message, "keyHandleId"))
writer.uint32(/* id 2, wireType 2 =*/18).string(message.keyHandleId);
if (message.keyHandle != null && Object.hasOwnProperty.call(message, "keyHandle"))
$root.google.cloud.kms.v1.KeyHandle.encode(message.keyHandle, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
return writer;
};
/**
* Encodes the specified CreateKeyHandleRequest message, length delimited. Does not implicitly {@link google.cloud.kms.v1.CreateKeyHandleRequest.verify|verify} messages.
* @function encodeDelimited
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.ICreateKeyHandleRequest} message CreateKeyHandleRequest message or plain object to encode
* @param {$protobuf.Writer} [writer] Writer to encode to
* @returns {$protobuf.Writer} Writer
*/
CreateKeyHandleRequest.encodeDelimited = function encodeDelimited(message, writer) {
return this.encode(message, writer).ldelim();
};
/**
* Decodes a CreateKeyHandleRequest message from the specified reader or buffer.
* @function decode
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
* @param {number} [length] Message length if known beforehand
* @returns {google.cloud.kms.v1.CreateKeyHandleRequest} CreateKeyHandleRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
CreateKeyHandleRequest.decode = function decode(reader, length, error) {
if (!(reader instanceof $Reader))
reader = $Reader.create(reader);
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.kms.v1.CreateKeyHandleRequest();
while (reader.pos < end) {
var tag = reader.uint32();
if (tag === error)
break;
switch (tag >>> 3) {
case 1: {
message.parent = reader.string();
break;
}
case 2: {
message.keyHandleId = reader.string();
break;
}
case 3: {
message.keyHandle = $root.google.cloud.kms.v1.KeyHandle.decode(reader, reader.uint32());
break;
}
default:
reader.skipType(tag & 7);
break;
}
}
return message;
};
/**
* Decodes a CreateKeyHandleRequest message from the specified reader or buffer, length delimited.
* @function decodeDelimited
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
* @returns {google.cloud.kms.v1.CreateKeyHandleRequest} CreateKeyHandleRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
CreateKeyHandleRequest.decodeDelimited = function decodeDelimited(reader) {
if (!(reader instanceof $Reader))
reader = new $Reader(reader);
return this.decode(reader, reader.uint32());
};
/**
* Verifies a CreateKeyHandleRequest message.
* @function verify
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {Object.<string,*>} message Plain object to verify
* @returns {string|null} `null` if valid, otherwise the reason why it is not
*/
CreateKeyHandleRequest.verify = function verify(message) {
if (typeof message !== "object" || message === null)
return "object expected";
if (message.parent != null && message.hasOwnProperty("parent"))
if (!$util.isString(message.parent))
return "parent: string expected";
if (message.keyHandleId != null && message.hasOwnProperty("keyHandleId"))
if (!$util.isString(message.keyHandleId))
return "keyHandleId: string expected";
if (message.keyHandle != null && message.hasOwnProperty("keyHandle")) {
var error = $root.google.cloud.kms.v1.KeyHandle.verify(message.keyHandle);
if (error)
return "keyHandle." + error;
}
return null;
};
/**
* Creates a CreateKeyHandleRequest message from a plain object. Also converts values to their respective internal types.
* @function fromObject
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {Object.<string,*>} object Plain object
* @returns {google.cloud.kms.v1.CreateKeyHandleRequest} CreateKeyHandleRequest
*/
CreateKeyHandleRequest.fromObject = function fromObject(object) {
if (object instanceof $root.google.cloud.kms.v1.CreateKeyHandleRequest)
return object;
var message = new $root.google.cloud.kms.v1.CreateKeyHandleRequest();
if (object.parent != null)
message.parent = String(object.parent);
if (object.keyHandleId != null)
message.keyHandleId = String(object.keyHandleId);
if (object.keyHandle != null) {
if (typeof object.keyHandle !== "object")
throw TypeError(".google.cloud.kms.v1.CreateKeyHandleRequest.keyHandle: object expected");
message.keyHandle = $root.google.cloud.kms.v1.KeyHandle.fromObject(object.keyHandle);
}
return message;
};
/**
* Creates a plain object from a CreateKeyHandleRequest message. Also converts values to other types if specified.
* @function toObject
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.CreateKeyHandleRequest} message CreateKeyHandleRequest
* @param {$protobuf.IConversionOptions} [options] Conversion options
* @returns {Object.<string,*>} Plain object
*/
CreateKeyHandleRequest.toObject = function toObject(message, options) {
if (!options)
options = {};
var object = {};
if (options.defaults) {
object.parent = "";
object.keyHandleId = "";
object.keyHandle = null;
}
if (message.parent != null && message.hasOwnProperty("parent"))
object.parent = message.parent;
if (message.keyHandleId != null && message.hasOwnProperty("keyHandleId"))
object.keyHandleId = message.keyHandleId;
if (message.keyHandle != null && message.hasOwnProperty("keyHandle"))
object.keyHandle = $root.google.cloud.kms.v1.KeyHandle.toObject(message.keyHandle, options);
return object;
};
/**
* Converts this CreateKeyHandleRequest to JSON.
* @function toJSON
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @instance
* @returns {Object.<string,*>} JSON object
*/
CreateKeyHandleRequest.prototype.toJSON = function toJSON() {
return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
};
/**
* Gets the default type url for CreateKeyHandleRequest
* @function getTypeUrl
* @memberof google.cloud.kms.v1.CreateKeyHandleRequest
* @static
* @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns {string} The default type url
*/
CreateKeyHandleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
if (typeUrlPrefix === undefined) {
typeUrlPrefix = "type.googleapis.com";
}
return typeUrlPrefix + "/google.cloud.kms.v1.CreateKeyHandleRequest";
};
return CreateKeyHandleRequest;
})();
v1.GetKeyHandleRequest = (function() {
/**
* Properties of a GetKeyHandleRequest.
* @memberof google.cloud.kms.v1
* @interface IGetKeyHandleRequest
* @property {string|null} [name] GetKeyHandleRequest name
*/
/**
* Constructs a new GetKeyHandleRequest.
* @memberof google.cloud.kms.v1
* @classdesc Represents a GetKeyHandleRequest.
* @implements IGetKeyHandleRequest
* @constructor
* @param {google.cloud.kms.v1.IGetKeyHandleRequest=} [properties] Properties to set
*/
function GetKeyHandleRequest(properties) {
if (properties)
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
if (properties[keys[i]] != null)
this[keys[i]] = properties[keys[i]];
}
/**
* GetKeyHandleRequest name.
* @member {string} name
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @instance
*/
GetKeyHandleRequest.prototype.name = "";
/**
* Creates a new GetKeyHandleRequest instance using the specified properties.
* @function create
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.IGetKeyHandleRequest=} [properties] Properties to set
* @returns {google.cloud.kms.v1.GetKeyHandleRequest} GetKeyHandleRequest instance
*/
GetKeyHandleRequest.create = function create(properties) {
return new GetKeyHandleRequest(properties);
};
/**
* Encodes the specified GetKeyHandleRequest message. Does not implicitly {@link google.cloud.kms.v1.GetKeyHandleRequest.verify|verify} messages.
* @function encode
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.IGetKeyHandleRequest} message GetKeyHandleRequest message or plain object to encode
* @param {$protobuf.Writer} [writer] Writer to encode to
* @returns {$protobuf.Writer} Writer
*/
GetKeyHandleRequest.encode = function encode(message, writer) {
if (!writer)
writer = $Writer.create();
if (message.name != null && Object.hasOwnProperty.call(message, "name"))
writer.uint32(/* id 1, wireType 2 =*/10).string(message.name);
return writer;
};
/**
* Encodes the specified GetKeyHandleRequest message, length delimited. Does not implicitly {@link google.cloud.kms.v1.GetKeyHandleRequest.verify|verify} messages.
* @function encodeDelimited
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.IGetKeyHandleRequest} message GetKeyHandleRequest message or plain object to encode
* @param {$protobuf.Writer} [writer] Writer to encode to
* @returns {$protobuf.Writer} Writer
*/
GetKeyHandleRequest.encodeDelimited = function encodeDelimited(message, writer) {
return this.encode(message, writer).ldelim();
};
/**
* Decodes a GetKeyHandleRequest message from the specified reader or buffer.
* @function decode
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
* @param {number} [length] Message length if known beforehand
* @returns {google.cloud.kms.v1.GetKeyHandleRequest} GetKeyHandleRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
GetKeyHandleRequest.decode = function decode(reader, length, error) {
if (!(reader instanceof $Reader))
reader = $Reader.create(reader);
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.kms.v1.GetKeyHandleRequest();
while (reader.pos < end) {
var tag = reader.uint32();
if (tag === error)
break;
switch (tag >>> 3) {
case 1: {
message.name = reader.string();
break;
}
default:
reader.skipType(tag & 7);
break;
}
}
return message;
};
/**
* Decodes a GetKeyHandleRequest message from the specified reader or buffer, length delimited.
* @function decodeDelimited
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
* @returns {google.cloud.kms.v1.GetKeyHandleRequest} GetKeyHandleRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
GetKeyHandleRequest.decodeDelimited = function decodeDelimited(reader) {
if (!(reader instanceof $Reader))
reader = new $Reader(reader);
return this.decode(reader, reader.uint32());
};
/**
* Verifies a GetKeyHandleRequest message.
* @function verify
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {Object.<string,*>} message Plain object to verify
* @returns {string|null} `null` if valid, otherwise the reason why it is not
*/
GetKeyHandleRequest.verify = function verify(message) {
if (typeof message !== "object" || message === null)
return "object expected";
if (message.name != null && message.hasOwnProperty("name"))
if (!$util.isString(message.name))
return "name: string expected";
return null;
};
/**
* Creates a GetKeyHandleRequest message from a plain object. Also converts values to their respective internal types.
* @function fromObject
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {Object.<string,*>} object Plain object
* @returns {google.cloud.kms.v1.GetKeyHandleRequest} GetKeyHandleRequest
*/
GetKeyHandleRequest.fromObject = function fromObject(object) {
if (object instanceof $root.google.cloud.kms.v1.GetKeyHandleRequest)
return object;
var message = new $root.google.cloud.kms.v1.GetKeyHandleRequest();
if (object.name != null)
message.name = String(object.name);
return message;
};
/**
* Creates a plain object from a GetKeyHandleRequest message. Also converts values to other types if specified.
* @function toObject
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {google.cloud.kms.v1.GetKeyHandleRequest} message GetKeyHandleRequest
* @param {$protobuf.IConversionOptions} [options] Conversion options
* @returns {Object.<string,*>} Plain object
*/
GetKeyHandleRequest.toObject = function toObject(message, options) {
if (!options)
options = {};
var object = {};
if (options.defaults)
object.name = "";
if (message.name != null && message.hasOwnProperty("name"))
object.name = message.name;
return object;
};
/**
* Converts this GetKeyHandleRequest to JSON.
* @function toJSON
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @instance
* @returns {Object.<string,*>} JSON object
*/
GetKeyHandleRequest.prototype.toJSON = function toJSON() {
return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
};
/**
* Gets the default type url for GetKeyHandleRequest
* @function getTypeUrl
* @memberof google.cloud.kms.v1.GetKeyHandleRequest
* @static
* @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns {string} The default type url
*/
GetKeyHandleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
if (typeUrlPrefix === undefined) {
typeUrlPrefix = "type.googleapis.com";
}
return typeUrlPrefix + "/google.cloud.kms.v1.GetKeyHandleRequest";
};
return GetKeyHandleRequest;
})();
v1.KeyHandle = (function() {
/**
* Properties of a KeyHandle.
* @memberof google.cloud.kms.v1
* @interface IKeyHandle
* @property {string|null} [name] KeyHandle name
* @property {string|null} [kmsKey] KeyHandle kmsKey
* @property {string|null} [resourceTypeSelector] KeyHandle resourceTypeSelector
*/
/**
* Constructs a new KeyHandle.
* @memberof google.cloud.kms.v1
* @classdesc Represents a KeyHandle.
* @implements IKeyHandle
* @constructor
* @param {google.cloud.kms.v1.IKeyHandle=} [properties] Properties to set
*/
function KeyHandle(properties) {
if (properties)
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
if (properties[keys[i]] != null)
this[keys[i]] = properties[keys[i]];
}
/**
* KeyHandle name.
* @member {string} name
* @memberof google.cloud.kms.v1.KeyHandle
* @instance
*/
KeyHandle.prototype.name = "";
/**
* KeyHandle kmsKey.
* @member {string} kmsKey
* @memberof google.cloud.kms.v1.KeyHandle
* @instance
*/
KeyHandle.prototype.kmsKey = "";
/**
* KeyHandle resourceTypeSelector.
* @member {string} resourceTypeSelector
* @memberof google.cloud.kms.v1.KeyHandle
* @instance
*/
KeyHandle.prototype.resourceTypeSelector = "";
/**
* Creates a new KeyHandle instance using the specified properties.
* @function create
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {google.cloud.kms.v1.IKeyHandle=} [properties] Properties to set
* @returns {google.cloud.kms.v1.KeyHandle} KeyHandle instance
*/
KeyHandle.create = function create(properties) {
return new KeyHandle(properties);
};
/**
* Encodes the specified KeyHandle message. Does not implicitly {@link google.cloud.kms.v1.KeyHandle.verify|verify} messages.
* @function encode
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {google.cloud.kms.v1.IKeyHandle} message KeyHandle message or plain object to encode
* @param {$protobuf.Writer} [writer] Writer to encode to
* @returns {$protobuf.Writer} Writer
*/
KeyHandle.encode = function encode(message, writer) {
if (!writer)
writer = $Writer.create();
if (message.name != null && Object.hasOwnProperty.call(message, "name"))
writer.uint32(/* id 1, wireType 2 =*/10).string(message.name);
if (message.kmsKey != null && Object.hasOwnProperty.call(message, "kmsKey"))
writer.uint32(/* id 3, wireType 2 =*/26).string(message.kmsKey);
if (message.resourceTypeSelector != null && Object.hasOwnProperty.call(message, "resourceTypeSelector"))
writer.uint32(/* id 4, wireType 2 =*/34).string(message.resourceTypeSelector);
return writer;
};
/**
* Encodes the specified KeyHandle message, length delimited. Does not implicitly {@link google.cloud.kms.v1.KeyHandle.verify|verify} messages.
* @function encodeDelimited
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {google.cloud.kms.v1.IKeyHandle} message KeyHandle message or plain object to encode
* @param {$protobuf.Writer} [writer] Writer to encode to
* @returns {$protobuf.Writer} Writer
*/
KeyHandle.encodeDelimited = function encodeDelimited(message, writer) {
return this.encode(message, writer).ldelim();
};
/**
* Decodes a KeyHandle message from the specified reader or buffer.
* @function decode
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
* @param {number} [length] Message length if known beforehand
* @returns {google.cloud.kms.v1.KeyHandle} KeyHandle
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
KeyHandle.decode = function decode(reader, length, error) {
if (!(reader instanceof $Reader))
reader = $Reader.create(reader);
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.kms.v1.KeyHandle();
while (reader.pos < end) {
var tag = reader.uint32();
if (tag === error)
break;
switch (tag >>> 3) {
case 1: {
message.name = reader.string();
break;
}
case 3: {
message.kmsKey = reader.string();
break;
}
case 4: {
message.resourceTypeSelector = reader.string();
break;
}
default:
reader.skipType(tag & 7);
break;
}
}
return message;
};
/**
* Decodes a KeyHandle message from the specified reader or buffer, length delimited.
* @function decodeDelimited
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
* @returns {google.cloud.kms.v1.KeyHandle} KeyHandle
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
KeyHandle.decodeDelimited = function decodeDelimited(reader) {
if (!(reader instanceof $Reader))
reader = new $Reader(reader);
return this.decode(reader, reader.uint32());
};
/**
* Verifies a KeyHandle message.
* @function verify
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {Object.<string,*>} message Plain object to verify
* @returns {string|null} `null` if valid, otherwise the reason why it is not
*/
KeyHandle.verify = function verify(message) {
if (typeof message !== "object" || message === null)
return "object expected";
if (message.name != null && message.hasOwnProperty("name"))
if (!$util.isString(message.name))
return "name: string expected";
if (message.kmsKey != null && message.hasOwnProperty("kmsKey"))
if (!$util.isString(message.kmsKey))
return "kmsKey: string expected";
if (message.resourceTypeSelector != null && message.hasOwnProperty("resourceTypeSelector"))
if (!$util.isString(message.resourceTypeSelector))
return "resourceTypeSelector: string expected";
return null;
};
/**
* Creates a KeyHandle message from a plain object. Also converts values to their respective internal types.
* @function fromObject
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {Object.<string,*>} object Plain object
* @returns {google.cloud.kms.v1.KeyHandle} KeyHandle
*/
KeyHandle.fromObject = function fromObject(object) {
if (object instanceof $root.google.cloud.kms.v1.KeyHandle)
return object;
var message = new $root.google.cloud.kms.v1.KeyHandle();
if (object.name != null)
message.name = String(object.name);
if (object.kmsKey != null)
message.kmsKey = String(object.kmsKey);
if (object.resourceTypeSelector != null)
message.resourceTypeSelector = String(object.resourceTypeSelector);
return message;
};
/**
* Creates a plain object from a KeyHandle message. Also converts values to other types if specified.
* @function toObject
* @memberof google.cloud.kms.v1.KeyHandle
* @static
* @param {google.cloud.kms.v1.KeyHandle} message KeyHandle