ListVersions Method

Lists the key versions for the specified key.

Syntax

googlekms.listVersions(keyName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method lists the key versions for the key specified by KeyName.

Calling this method will fire the VersionList event once for each key version, and will also populate the Version* properties.

If there are still more key versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Version* properties.

The MaxVersions configuration setting can be used to control the maximum number of results to return at once.