Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.kms.v1.EkmConnection (3.3.1)

Represents an EkmConnection.

Package

@google-cloud/kms

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.kms.v1.IEkmConnection);

Constructs a new EkmConnection.

Parameter

Name	Description
`properties`	`IEkmConnection` Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

EkmConnection createTime.

etag

public etag: string;

EkmConnection etag.

name

public name: string;

EkmConnection name.

serviceResolvers

public serviceResolvers: google.cloud.kms.v1.EkmConnection.IServiceResolver[];

EkmConnection serviceResolvers.

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IEkmConnection): google.cloud.kms.v1.EkmConnection;

Creates a new EkmConnection instance using the specified properties.

Parameter

Name	Description
`properties`	`IEkmConnection` Properties to set

Returns

Type	Description
`google.cloud.kms.v1.EkmConnection`	EkmConnection instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.kms.v1.EkmConnection;

Decodes an EkmConnection message from the specified reader or buffer.

Parameters

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns

Type	Description
`google.cloud.kms.v1.EkmConnection`	EkmConnection

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.kms.v1.EkmConnection;

Decodes an EkmConnection message from the specified reader or buffer, length delimited.

Parameter

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
`google.cloud.kms.v1.EkmConnection`	EkmConnection

encode(message, writer)

public static encode(message: google.cloud.kms.v1.IEkmConnection, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified EkmConnection message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IEkmConnection` EkmConnection message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.kms.v1.IEkmConnection, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified EkmConnection message, length delimited. Does not implicitly messages.

Parameters

Name	Description
`message`	`IEkmConnection` EkmConnection message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.EkmConnection;

Creates an EkmConnection 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
`google.cloud.kms.v1.EkmConnection`	EkmConnection

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for EkmConnection

Parameter

Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
`string`	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this EkmConnection to JSON.

Returns

Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.kms.v1.EkmConnection, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an EkmConnection message. Also converts values to other types if specified.

Parameters

Name	Description
`message`	`google.cloud.kms.v1.EkmConnection` EkmConnection
`options`	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an EkmConnection message.

Parameter

Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not