Package com.ibm.cloud.ibm_key_protect_api.v2.model

Class PostImportTokenOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.ibm_key_protect_api.v2.model.PostImportTokenOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class PostImportTokenOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The postImportToken options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PostImportTokenOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	bluemixInstance()	Gets the bluemixInstance.
String	correlationId()	Gets the correlationId.
Double	expiration()	Gets the expiration.
Double	maxAllowedRetrievals()	Gets the maxAllowedRetrievals.
PostImportTokenOptions.Builder	newBuilder()	New builder.
String	xKmsKeyRing()	Gets the xKmsKeyRing.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public PostImportTokenOptions.Builder newBuilder()

New builder.

Returns:

a PostImportTokenOptions builder

bluemixInstance

public String bluemixInstance()

Gets the bluemixInstance. The IBM Cloud instance ID that identifies your Key Protect service instance.

Returns:

the bluemixInstance

expiration

public Double expiration()

Gets the expiration. The time in seconds from the creation of an import token that determines how long its associated public key remains valid. The minimum value is `300` seconds (5 minutes), and the maximum value is `86400` (24 hours). The default value is `600` (10 minutes).

Returns:

the expiration

maxAllowedRetrievals

public Double maxAllowedRetrievals()

Gets the maxAllowedRetrievals. The number of times that an import token can be retrieved within its expiration time before it is no longer accessible.

Returns:

the maxAllowedRetrievals

correlationId

public String correlationId()

Gets the correlationId. The v4 UUID used to correlate and track transactions.

Returns:

the correlationId

xKmsKeyRing

public String xKmsKeyRing()

Gets the xKmsKeyRing. The ID of the key ring that the specified key belongs to. When the header is not specified, Key Protect will perform a key ring lookup. For a more optimized request, specify the key ring on every call. The key ring ID of keys that are created without an `X-Kms-Key-Ring` header is: `default`.

Returns:

the xKmsKeyRing