@google-cloud/kms
Version:
Google Cloud Key Management Service (KMS) API client for Node.js
917 lines (767 loc) • 938 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 kms. */
namespace kms {
/** Namespace v1. */
namespace v1 {
/** Represents an Autokey */
class Autokey extends $protobuf.rpc.Service {
/**
* Constructs a new Autokey 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 Autokey 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): Autokey;
/**
* Calls CreateKeyHandle.
* @param request CreateKeyHandleRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public createKeyHandle(request: google.cloud.kms.v1.ICreateKeyHandleRequest, callback: google.cloud.kms.v1.Autokey.CreateKeyHandleCallback): void;
/**
* Calls CreateKeyHandle.
* @param request CreateKeyHandleRequest message or plain object
* @returns Promise
*/
public createKeyHandle(request: google.cloud.kms.v1.ICreateKeyHandleRequest): Promise<google.longrunning.Operation>;
/**
* Calls GetKeyHandle.
* @param request GetKeyHandleRequest message or plain object
* @param callback Node-style callback called with the error, if any, and KeyHandle
*/
public getKeyHandle(request: google.cloud.kms.v1.IGetKeyHandleRequest, callback: google.cloud.kms.v1.Autokey.GetKeyHandleCallback): void;
/**
* Calls GetKeyHandle.
* @param request GetKeyHandleRequest message or plain object
* @returns Promise
*/
public getKeyHandle(request: google.cloud.kms.v1.IGetKeyHandleRequest): Promise<google.cloud.kms.v1.KeyHandle>;
/**
* Calls ListKeyHandles.
* @param request ListKeyHandlesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListKeyHandlesResponse
*/
public listKeyHandles(request: google.cloud.kms.v1.IListKeyHandlesRequest, callback: google.cloud.kms.v1.Autokey.ListKeyHandlesCallback): void;
/**
* Calls ListKeyHandles.
* @param request ListKeyHandlesRequest message or plain object
* @returns Promise
*/
public listKeyHandles(request: google.cloud.kms.v1.IListKeyHandlesRequest): Promise<google.cloud.kms.v1.ListKeyHandlesResponse>;
}
namespace Autokey {
/**
* Callback as used by {@link google.cloud.kms.v1.Autokey|createKeyHandle}.
* @param error Error, if any
* @param [response] Operation
*/
type CreateKeyHandleCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.kms.v1.Autokey|getKeyHandle}.
* @param error Error, if any
* @param [response] KeyHandle
*/
type GetKeyHandleCallback = (error: (Error|null), response?: google.cloud.kms.v1.KeyHandle) => void;
/**
* Callback as used by {@link google.cloud.kms.v1.Autokey|listKeyHandles}.
* @param error Error, if any
* @param [response] ListKeyHandlesResponse
*/
type ListKeyHandlesCallback = (error: (Error|null), response?: google.cloud.kms.v1.ListKeyHandlesResponse) => void;
}
/** Properties of a CreateKeyHandleRequest. */
interface ICreateKeyHandleRequest {
/** CreateKeyHandleRequest parent */
parent?: (string|null);
/** CreateKeyHandleRequest keyHandleId */
keyHandleId?: (string|null);
/** CreateKeyHandleRequest keyHandle */
keyHandle?: (google.cloud.kms.v1.IKeyHandle|null);
}
/** Represents a CreateKeyHandleRequest. */
class CreateKeyHandleRequest implements ICreateKeyHandleRequest {
/**
* Constructs a new CreateKeyHandleRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.kms.v1.ICreateKeyHandleRequest);
/** CreateKeyHandleRequest parent. */
public parent: string;
/** CreateKeyHandleRequest keyHandleId. */
public keyHandleId: string;
/** CreateKeyHandleRequest keyHandle. */
public keyHandle?: (google.cloud.kms.v1.IKeyHandle|null);
/**
* Creates a new CreateKeyHandleRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns CreateKeyHandleRequest instance
*/
public static create(properties?: google.cloud.kms.v1.ICreateKeyHandleRequest): google.cloud.kms.v1.CreateKeyHandleRequest;
/**
* Encodes the specified CreateKeyHandleRequest message. Does not implicitly {@link google.cloud.kms.v1.CreateKeyHandleRequest.verify|verify} messages.
* @param message CreateKeyHandleRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.kms.v1.ICreateKeyHandleRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CreateKeyHandleRequest message, length delimited. Does not implicitly {@link google.cloud.kms.v1.CreateKeyHandleRequest.verify|verify} messages.
* @param message CreateKeyHandleRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.kms.v1.ICreateKeyHandleRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CreateKeyHandleRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CreateKeyHandleRequest
* @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.kms.v1.CreateKeyHandleRequest;
/**
* Decodes a CreateKeyHandleRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CreateKeyHandleRequest
* @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.kms.v1.CreateKeyHandleRequest;
/**
* Verifies a CreateKeyHandleRequest 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 CreateKeyHandleRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CreateKeyHandleRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.CreateKeyHandleRequest;
/**
* Creates a plain object from a CreateKeyHandleRequest message. Also converts values to other types if specified.
* @param message CreateKeyHandleRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.kms.v1.CreateKeyHandleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CreateKeyHandleRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CreateKeyHandleRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GetKeyHandleRequest. */
interface IGetKeyHandleRequest {
/** GetKeyHandleRequest name */
name?: (string|null);
}
/** Represents a GetKeyHandleRequest. */
class GetKeyHandleRequest implements IGetKeyHandleRequest {
/**
* Constructs a new GetKeyHandleRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.kms.v1.IGetKeyHandleRequest);
/** GetKeyHandleRequest name. */
public name: string;
/**
* Creates a new GetKeyHandleRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns GetKeyHandleRequest instance
*/
public static create(properties?: google.cloud.kms.v1.IGetKeyHandleRequest): google.cloud.kms.v1.GetKeyHandleRequest;
/**
* Encodes the specified GetKeyHandleRequest message. Does not implicitly {@link google.cloud.kms.v1.GetKeyHandleRequest.verify|verify} messages.
* @param message GetKeyHandleRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.kms.v1.IGetKeyHandleRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GetKeyHandleRequest message, length delimited. Does not implicitly {@link google.cloud.kms.v1.GetKeyHandleRequest.verify|verify} messages.
* @param message GetKeyHandleRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.kms.v1.IGetKeyHandleRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GetKeyHandleRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GetKeyHandleRequest
* @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.kms.v1.GetKeyHandleRequest;
/**
* Decodes a GetKeyHandleRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GetKeyHandleRequest
* @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.kms.v1.GetKeyHandleRequest;
/**
* Verifies a GetKeyHandleRequest 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 GetKeyHandleRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GetKeyHandleRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.GetKeyHandleRequest;
/**
* Creates a plain object from a GetKeyHandleRequest message. Also converts values to other types if specified.
* @param message GetKeyHandleRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.kms.v1.GetKeyHandleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GetKeyHandleRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GetKeyHandleRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a KeyHandle. */
interface IKeyHandle {
/** KeyHandle name */
name?: (string|null);
/** KeyHandle kmsKey */
kmsKey?: (string|null);
/** KeyHandle resourceTypeSelector */
resourceTypeSelector?: (string|null);
}
/** Represents a KeyHandle. */
class KeyHandle implements IKeyHandle {
/**
* Constructs a new KeyHandle.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.kms.v1.IKeyHandle);
/** KeyHandle name. */
public name: string;
/** KeyHandle kmsKey. */
public kmsKey: string;
/** KeyHandle resourceTypeSelector. */
public resourceTypeSelector: string;
/**
* Creates a new KeyHandle instance using the specified properties.
* @param [properties] Properties to set
* @returns KeyHandle instance
*/
public static create(properties?: google.cloud.kms.v1.IKeyHandle): google.cloud.kms.v1.KeyHandle;
/**
* Encodes the specified KeyHandle message. Does not implicitly {@link google.cloud.kms.v1.KeyHandle.verify|verify} messages.
* @param message KeyHandle message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.kms.v1.IKeyHandle, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified KeyHandle message, length delimited. Does not implicitly {@link google.cloud.kms.v1.KeyHandle.verify|verify} messages.
* @param message KeyHandle message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.kms.v1.IKeyHandle, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a KeyHandle message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns KeyHandle
* @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.kms.v1.KeyHandle;
/**
* Decodes a KeyHandle message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns KeyHandle
* @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.kms.v1.KeyHandle;
/**
* Verifies a KeyHandle 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 KeyHandle message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns KeyHandle
*/
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.KeyHandle;
/**
* Creates a plain object from a KeyHandle message. Also converts values to other types if specified.
* @param message KeyHandle
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.kms.v1.KeyHandle, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this KeyHandle to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for KeyHandle
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a CreateKeyHandleMetadata. */
interface ICreateKeyHandleMetadata {
}
/** Represents a CreateKeyHandleMetadata. */
class CreateKeyHandleMetadata implements ICreateKeyHandleMetadata {
/**
* Constructs a new CreateKeyHandleMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.kms.v1.ICreateKeyHandleMetadata);
/**
* Creates a new CreateKeyHandleMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns CreateKeyHandleMetadata instance
*/
public static create(properties?: google.cloud.kms.v1.ICreateKeyHandleMetadata): google.cloud.kms.v1.CreateKeyHandleMetadata;
/**
* Encodes the specified CreateKeyHandleMetadata message. Does not implicitly {@link google.cloud.kms.v1.CreateKeyHandleMetadata.verify|verify} messages.
* @param message CreateKeyHandleMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.kms.v1.ICreateKeyHandleMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CreateKeyHandleMetadata message, length delimited. Does not implicitly {@link google.cloud.kms.v1.CreateKeyHandleMetadata.verify|verify} messages.
* @param message CreateKeyHandleMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.kms.v1.ICreateKeyHandleMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CreateKeyHandleMetadata message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CreateKeyHandleMetadata
* @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.kms.v1.CreateKeyHandleMetadata;
/**
* Decodes a CreateKeyHandleMetadata message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CreateKeyHandleMetadata
* @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.kms.v1.CreateKeyHandleMetadata;
/**
* Verifies a CreateKeyHandleMetadata 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 CreateKeyHandleMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CreateKeyHandleMetadata
*/
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.CreateKeyHandleMetadata;
/**
* Creates a plain object from a CreateKeyHandleMetadata message. Also converts values to other types if specified.
* @param message CreateKeyHandleMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.kms.v1.CreateKeyHandleMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CreateKeyHandleMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CreateKeyHandleMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ListKeyHandlesRequest. */
interface IListKeyHandlesRequest {
/** ListKeyHandlesRequest parent */
parent?: (string|null);
/** ListKeyHandlesRequest pageSize */
pageSize?: (number|null);
/** ListKeyHandlesRequest pageToken */
pageToken?: (string|null);
/** ListKeyHandlesRequest filter */
filter?: (string|null);
}
/** Represents a ListKeyHandlesRequest. */
class ListKeyHandlesRequest implements IListKeyHandlesRequest {
/**
* Constructs a new ListKeyHandlesRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.kms.v1.IListKeyHandlesRequest);
/** ListKeyHandlesRequest parent. */
public parent: string;
/** ListKeyHandlesRequest pageSize. */
public pageSize: number;
/** ListKeyHandlesRequest pageToken. */
public pageToken: string;
/** ListKeyHandlesRequest filter. */
public filter: string;
/**
* Creates a new ListKeyHandlesRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns ListKeyHandlesRequest instance
*/
public static create(properties?: google.cloud.kms.v1.IListKeyHandlesRequest): google.cloud.kms.v1.ListKeyHandlesRequest;
/**
* Encodes the specified ListKeyHandlesRequest message. Does not implicitly {@link google.cloud.kms.v1.ListKeyHandlesRequest.verify|verify} messages.
* @param message ListKeyHandlesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.kms.v1.IListKeyHandlesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ListKeyHandlesRequest message, length delimited. Does not implicitly {@link google.cloud.kms.v1.ListKeyHandlesRequest.verify|verify} messages.
* @param message ListKeyHandlesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.kms.v1.IListKeyHandlesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ListKeyHandlesRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ListKeyHandlesRequest
* @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.kms.v1.ListKeyHandlesRequest;
/**
* Decodes a ListKeyHandlesRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ListKeyHandlesRequest
* @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.kms.v1.ListKeyHandlesRequest;
/**
* Verifies a ListKeyHandlesRequest 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 ListKeyHandlesRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ListKeyHandlesRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.ListKeyHandlesRequest;
/**
* Creates a plain object from a ListKeyHandlesRequest message. Also converts values to other types if specified.
* @param message ListKeyHandlesRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.kms.v1.ListKeyHandlesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ListKeyHandlesRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ListKeyHandlesRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ListKeyHandlesResponse. */
interface IListKeyHandlesResponse {
/** ListKeyHandlesResponse keyHandles */
keyHandles?: (google.cloud.kms.v1.IKeyHandle[]|null);
/** ListKeyHandlesResponse nextPageToken */
nextPageToken?: (string|null);
}
/** Represents a ListKeyHandlesResponse. */
class ListKeyHandlesResponse implements IListKeyHandlesResponse {
/**
* Constructs a new ListKeyHandlesResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.kms.v1.IListKeyHandlesResponse);
/** ListKeyHandlesResponse keyHandles. */
public keyHandles: google.cloud.kms.v1.IKeyHandle[];
/** ListKeyHandlesResponse nextPageToken. */
public nextPageToken: string;
/**
* Creates a new ListKeyHandlesResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns ListKeyHandlesResponse instance
*/
public static create(properties?: google.cloud.kms.v1.IListKeyHandlesResponse): google.cloud.kms.v1.ListKeyHandlesResponse;
/**
* Encodes the specified ListKeyHandlesResponse message. Does not implicitly {@link google.cloud.kms.v1.ListKeyHandlesResponse.verify|verify} messages.
* @param message ListKeyHandlesResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.kms.v1.IListKeyHandlesResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ListKeyHandlesResponse message, length delimited. Does not implicitly {@link google.cloud.kms.v1.ListKeyHandlesResponse.verify|verify} messages.
* @param message ListKeyHandlesResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.kms.v1.IListKeyHandlesResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ListKeyHandlesResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ListKeyHandlesResponse
* @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.kms.v1.ListKeyHandlesResponse;
/**
* Decodes a ListKeyHandlesResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ListKeyHandlesResponse
* @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.kms.v1.ListKeyHandlesResponse;
/**
* Verifies a ListKeyHandlesResponse 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 ListKeyHandlesResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ListKeyHandlesResponse
*/
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.ListKeyHandlesResponse;
/**
* Creates a plain object from a ListKeyHandlesResponse message. Also converts values to other types if specified.
* @param message ListKeyHandlesResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.kms.v1.ListKeyHandlesResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ListKeyHandlesResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ListKeyHandlesResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Represents an AutokeyAdmin */
class AutokeyAdmin extends $protobuf.rpc.Service {
/**
* Constructs a new AutokeyAdmin 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 AutokeyAdmin 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): AutokeyAdmin;
/**
* Calls UpdateAutokeyConfig.
* @param request UpdateAutokeyConfigRequest message or plain object
* @param callback Node-style callback called with the error, if any, and AutokeyConfig
*/
public updateAutokeyConfig(request: google.cloud.kms.v1.IUpdateAutokeyConfigRequest, callback: google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfigCallback): void;
/**
* Calls UpdateAutokeyConfig.
* @param request UpdateAutokeyConfigRequest message or plain object
* @returns Promise
*/
public updateAutokeyConfig(request: google.cloud.kms.v1.IUpdateAutokeyConfigRequest): Promise<google.cloud.kms.v1.AutokeyConfig>;
/**
* Calls GetAutokeyConfig.
* @param request GetAutokeyConfigRequest message or plain object
* @param callback Node-style callback called with the error, if any, and AutokeyConfig
*/
public getAutokeyConfig(request: google.cloud.kms.v1.IGetAutokeyConfigRequest, callback: google.cloud.kms.v1.AutokeyAdmin.GetAutokeyConfigCallback): void;
/**
* Calls GetAutokeyConfig.
* @param request GetAutokeyConfigRequest message or plain object
* @returns Promise
*/
public getAutokeyConfig(request: google.cloud.kms.v1.IGetAutokeyConfigRequest): Promise<google.cloud.kms.v1.AutokeyConfig>;
/**
* Calls ShowEffectiveAutokeyConfig.
* @param request ShowEffectiveAutokeyConfigRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ShowEffectiveAutokeyConfigResponse
*/
public showEffectiveAutokeyConfig(request: google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest, callback: google.cloud.kms.v1.AutokeyAdmin.ShowEffectiveAutokeyConfigCallback): void;
/**
* Calls ShowEffectiveAutokeyConfig.
* @param request ShowEffectiveAutokeyConfigRequest message or plain object
* @returns Promise
*/
public showEffectiveAutokeyConfig(request: google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest): Promise<google.cloud.kms.v1.ShowEffectiveAutokeyConfigResponse>;
}
namespace AutokeyAdmin {
/**
* Callback as used by {@link google.cloud.kms.v1.AutokeyAdmin|updateAutokeyConfig}.
* @param error Error, if any
* @param [response] AutokeyConfig
*/
type UpdateAutokeyConfigCallback = (error: (Error|null), response?: google.cloud.kms.v1.AutokeyConfig) => void;
/**
* Callback as used by {@link google.cloud.kms.v1.AutokeyAdmin|getAutokeyConfig}.
* @param error Error, if any
* @param [response] AutokeyConfig
*/
type GetAutokeyConfigCallback = (error: (Error|null), response?: google.cloud.kms.v1.AutokeyConfig) => void;
/**
* Callback as used by {@link google.cloud.kms.v1.AutokeyAdmin|showEffectiveAutokeyConfig}.
* @param error Error, if any
* @param [response] ShowEffectiveAutokeyConfigResponse
*/
type ShowEffectiveAutokeyConfigCallback = (error: (Error|null), response?: google.cloud.kms.v1.ShowEffectiveAutokeyConfigResponse) => void;
}
/** Properties of an UpdateAutokeyConfigRequest. */
interface IUpdateAutokeyConfigRequest {
/** UpdateAutokeyConfigRequest autokeyConfig */
autokeyConfig?: (google.cloud.kms.v1.IAutokeyConfig|null);
/** UpdateAutokeyConfigRequest updateMask */
updateMask?: (google.protobuf.IFieldMask|null);
}
/** Represents an UpdateAutokeyConfigRequest. */
class UpdateAutokeyConfigRequest implements IUpdateAutokeyConfigRequest {
/**
* Constructs a new UpdateAutokeyConfigRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.kms.v1.IUpdateAutokeyConfigRequest);
/** UpdateAutokeyConfigRequest autokeyConfig. */
public autokeyConfig?: (google.cloud.kms.v1.IAutokeyConfig|null);
/** UpdateAutokeyConfigRequest updateMask. */
public updateMask?: (google.protobuf.IFieldMask|null);
/**
* Creates a new UpdateAutokeyConfigRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns UpdateAutokeyConfigRequest instance
*/
public static create(properties?: google.cloud.kms.v1.IUpdateAutokeyConfigRequest): google.cloud.kms.v1.UpdateAutokeyConfigRequest;
/**
* Encodes the specified UpdateAutokeyConfigRequest message. Does not implicitly {@link google.cloud.kms.v1.UpdateAutokeyConfigRequest.verify|verify} messages.
* @param message UpdateAutokeyConfigRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.kms.v1.IUpdateAutokeyConfigRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UpdateAutokeyConfigRequest message, length delimited. Does not implicitly {@link google.cloud.kms.v1.UpdateAutokeyConfigRequest.verify|verify} messages.
* @param message UpdateAutokeyConfigRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.kms.v1.IUpdateAutokeyConfigRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an UpdateAutokeyConfigRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UpdateAutokeyConfigRequest
* @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.kms.v1.UpdateAutokeyConfigRequest;
/**
* Decodes an UpdateAutokeyConfigRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UpdateAutokeyConfigRequest
* @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.kms.v1.UpdateAutokeyConfigRequest;
/**
* Verifies an UpdateAutokeyConfigRequest 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 UpdateAutokeyConfigRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UpdateAutokeyConfigRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.UpdateAutokeyConfigRequest;
/**
* Creates a plain object from an UpdateAutokeyConfigRequest message. Also converts values to other types if specified.
* @param message UpdateAutokeyConfigRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.kms.v1.UpdateAutokeyConfigRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Con