Class protos.google.cloud.kms.v1.ImportJob (3.5.1)

Represents an ImportJob.

Package

@google-cloud/kms

Constructors

(constructor)(properties)

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

Constructs a new ImportJob.

Parameter
Name Description
properties IImportJob

Properties to set

Properties

attestation

public attestation?: (google.cloud.kms.v1.IKeyOperationAttestation|null);

ImportJob attestation.

createTime

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

ImportJob createTime.

expireEventTime

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

ImportJob expireEventTime.

expireTime

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

ImportJob expireTime.

generateTime

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

ImportJob generateTime.

importMethod

public importMethod: (google.cloud.kms.v1.ImportJob.ImportMethod|keyof typeof google.cloud.kms.v1.ImportJob.ImportMethod);

ImportJob importMethod.

name

public name: string;

ImportJob name.

protectionLevel

public protectionLevel: (google.cloud.kms.v1.ProtectionLevel|keyof typeof google.cloud.kms.v1.ProtectionLevel);

ImportJob protectionLevel.

publicKey

public publicKey?: (google.cloud.kms.v1.ImportJob.IWrappingPublicKey|null);

ImportJob publicKey.

state

public state: (google.cloud.kms.v1.ImportJob.ImportJobState|keyof typeof google.cloud.kms.v1.ImportJob.ImportJobState);

ImportJob state.

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IImportJob): google.cloud.kms.v1.ImportJob;

Creates a new ImportJob instance using the specified properties.

Parameter
Name Description
properties IImportJob

Properties to set

Returns
Type Description
google.cloud.kms.v1.ImportJob

ImportJob instance

decode(reader, length)

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

Decodes an ImportJob 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.ImportJob

ImportJob

decodeDelimited(reader)

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

Decodes an ImportJob 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.ImportJob

ImportJob

encode(message, writer)

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

Encodes the specified ImportJob message. Does not implicitly messages.

Parameters
Name Description
message IImportJob

ImportJob 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.IImportJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IImportJob

ImportJob 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.ImportJob;

Creates an ImportJob 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.ImportJob

ImportJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ImportJob

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 ImportJob to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.kms.v1.ImportJob

ImportJob

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 ImportJob 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