com.oracle.bmc.keymanagement.model

Class KeySummary.Builder

java.lang.Object

com.oracle.bmc.keymanagement.model.KeySummary.Builder

Enclosing class:

KeySummary

public static class KeySummary.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
KeySummary.Builder	algorithm(KeySummary.Algorithm algorithm) The algorithm used by a key’s key versions to encrypt or decrypt data.
KeySummary	build()
KeySummary.Builder	compartmentId(String compartmentId) The OCID of the compartment that contains the key.
KeySummary.Builder	copy(KeySummary model)
KeySummary.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
KeySummary.Builder	displayName(String displayName) A user-friendly name for the key.
KeySummary.Builder	externalKeyReferenceDetails(ExternalKeyReferenceDetails externalKeyReferenceDetails)
KeySummary.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
KeySummary.Builder	id(String id) The OCID of the key.
KeySummary.Builder	isAutoRotationEnabled(Boolean isAutoRotationEnabled) A parameter specifying whether the auto key rotation is enabled or not.
KeySummary.Builder	lifecycleState(KeySummary.LifecycleState lifecycleState) The key’s current lifecycle state.
KeySummary.Builder	protectionMode(KeySummary.ProtectionMode protectionMode) The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
KeySummary.Builder	timeCreated(Date timeCreated) The date and time the key was created, expressed in RFC 3339 timestamp format.
KeySummary.Builder	vaultId(String vaultId) The OCID of the vault that contains the key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public KeySummary.Builder compartmentId(String compartmentId)

The OCID of the compartment that contains the key.

Parameters:

compartmentId - the value to set

Returns:

this builder

definedTags

public KeySummary.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

displayName

public KeySummary.Builder displayName(String displayName)

A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

freeformTags

public KeySummary.Builder freeformTags(Map<String,String> freeformTags)

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

id

public KeySummary.Builder id(String id)

The OCID of the key.

Parameters:

id - the value to set

Returns:

this builder

lifecycleState

public KeySummary.Builder lifecycleState(KeySummary.LifecycleState lifecycleState)

The key’s current lifecycle state.

Example: ENABLED

Parameters:

lifecycleState - the value to set

Returns:

this builder

timeCreated

public KeySummary.Builder timeCreated(Date timeCreated)

The date and time the key was created, expressed in RFC 3339 timestamp format.

Example: 2018-04-03T21:10:29.600Z

Parameters:

timeCreated - the value to set

Returns:

this builder

vaultId

public KeySummary.Builder vaultId(String vaultId)

The OCID of the vault that contains the key.

Parameters:

vaultId - the value to set

Returns:

this builder

protectionMode

public KeySummary.Builder protectionMode(KeySummary.ProtectionMode protectionMode)

The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault’s RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key’s protection mode is set to HSM. You can’t change a key’s protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer’s external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

Parameters:

protectionMode - the value to set

Returns:

this builder

algorithm

public KeySummary.Builder algorithm(KeySummary.Algorithm algorithm)

The algorithm used by a key’s key versions to encrypt or decrypt data.

Parameters:

algorithm - the value to set

Returns:

this builder

externalKeyReferenceDetails

public KeySummary.Builder externalKeyReferenceDetails(ExternalKeyReferenceDetails externalKeyReferenceDetails)

isAutoRotationEnabled

public KeySummary.Builder isAutoRotationEnabled(Boolean isAutoRotationEnabled)

A parameter specifying whether the auto key rotation is enabled or not.

Parameters:

isAutoRotationEnabled - the value to set

Returns:

this builder

build

public KeySummary build()

copy

public KeySummary.Builder copy(KeySummary model)