Class protos.google.cloud.kms.v1.EkmConfig (4.5.0)
Represents an EkmConfig.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor(properties?:google.cloud.kms.v1.IEkmConfig);Constructs a new EkmConfig.
| Parameter | |
|---|---|
| Name | Description |
properties | IEkmConfigProperties to set |
Properties
defaultEkmConnection
publicdefaultEkmConnection:string;EkmConfig defaultEkmConnection.
name
publicname:string;EkmConfig name.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.kms.v1.IEkmConfig):google.cloud.kms.v1.EkmConfig;Creates a new EkmConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IEkmConfigProperties to set |
| Returns | |
|---|---|
| Type | Description |
EkmConfig | EkmConfig instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.kms.v1.EkmConfig;Decodes an EkmConfig message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
EkmConfig | EkmConfig |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.kms.v1.EkmConfig;Decodes an EkmConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
EkmConfig | EkmConfig |
encode(message, writer)
publicstaticencode(message:google.cloud.kms.v1.IEkmConfig,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified EkmConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IEkmConfigEkmConfig message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.kms.v1.IEkmConfig,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified EkmConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IEkmConfigEkmConfig message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.kms.v1.EkmConfig;Creates an EkmConfig message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object | { [k: string]: any }Plain object |
| Returns | |
|---|---|
| Type | Description |
EkmConfig | EkmConfig |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for EkmConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this EkmConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.kms.v1.EkmConfig,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from an EkmConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | EkmConfigEkmConfig |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies an EkmConfig message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.