Package com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model

Class SecretVersionPrototype

java.lang.Object

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

com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model.SecretVersionPrototype

All Implemented Interfaces:

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

Direct Known Subclasses:

ArbitrarySecretVersionPrototype, CustomCredentialsSecretVersionPrototype, IAMCredentialsSecretRestoreFromVersionPrototype, IAMCredentialsSecretVersionPrototype, ImportedCertificateVersionPrototype, KVSecretVersionPrototype, PrivateCertificateVersionPrototype, PublicCertificateVersionPrototype, ServiceCredentialsSecretVersionPrototype, UsernamePasswordSecretVersionPrototype

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

Specify the properties for your new secret version. Classes which extend this class: - ArbitrarySecretVersionPrototype - IAMCredentialsSecretRestoreFromVersionPrototype - IAMCredentialsSecretVersionPrototype - ImportedCertificateVersionPrototype - KVSecretVersionPrototype - PrivateCertificateVersionPrototype - PublicCertificateVersionPrototype - ServiceCredentialsSecretVersionPrototype - UsernamePasswordSecretVersionPrototype - CustomCredentialsSecretVersionPrototype

Method Summary

Modifier and Type	Method	Description
String	certificate()	Gets the certificate.
String	csr()	Gets the csr.
Map<String,Object>	customMetadata()	Gets the customMetadata.
Map<String,Object>	data()	Gets the data.
String	intermediate()	Gets the intermediate.
String	password()	Gets the password.
String	payload()	Gets the payload.
String	privateKey()	Gets the privateKey.
String	restoreFromVersion()	Gets the restoreFromVersion.
PublicCertificateRotationObject	rotation()	Gets the rotation.
Map<String,Object>	versionCustomMetadata()	Gets the versionCustomMetadata.

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

payload

public String payload()

Gets the payload. The secret data that is assigned to an `arbitrary` secret.

Returns:

the payload

customMetadata

public Map<String,Object> customMetadata()

Gets the customMetadata. The secret metadata that a user can customize.

Returns:

the customMetadata

versionCustomMetadata

public Map<String,Object> versionCustomMetadata()

Gets the versionCustomMetadata. The secret version metadata that a user can customize.

Returns:

the versionCustomMetadata

restoreFromVersion

public String restoreFromVersion()

Gets the restoreFromVersion. A UUID identifier, or `current` or `previous` secret version aliases.

Returns:

the restoreFromVersion

certificate

public String certificate()

Gets the certificate. Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.

Returns:

the certificate

intermediate

public String intermediate()

Gets the intermediate. The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on a single line with embedded newline characters.

Returns:

the intermediate

privateKey

public String privateKey()

Gets the privateKey. The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line with embedded newline characters.

Returns:

the privateKey

data

public Map<String,Object> data()

Gets the data. The payload data of a key-value secret.

Returns:

the data

csr

public String csr()

Gets the csr. The certificate signing request.

Returns:

the csr

rotation

public PublicCertificateRotationObject rotation()

Gets the rotation. Defines the rotation object that is used to manually rotate public certificates.

Returns:

the rotation

password

public String password()

Gets the password. The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager generates a new random password for your secret.

Returns:

the password