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

Class SecretMetadataPatch

    • Method Detail

      • name

        public String name()
        Gets the name. A human-readable name to assign to your secret. To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.
        Returns:
        the name

      • description

        public String description()
        Gets the description. An extended description of your secret. To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
        Returns:
        the description

      • labels

        public List<String> labels()
        Gets the labels. Labels that you can use to search secrets in your instance. Only 30 labels can be created. Label can be between 2-64 characters, including spaces. To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
        Returns:
        the labels

      • customMetadata

        public Map<String,​Object> customMetadata()
        Gets the customMetadata. The secret metadata that a user can customize.
        Returns:
        the customMetadata

      • expirationDate

        public Date expirationDate()
        Gets the expirationDate. The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types: Arbitrary, username_password.
        Returns:
        the expirationDate

      • ttl

        public String ttl()
        Gets the ttl. The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types: iam_credentials, service_credentials, custom_credentials. The TTL defines how long generated credentials remain valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0. After the TTL is modified, it will be applied only on the next secret rotation. For the custom_credentials secret type, the TTL field is optional. The minimum duration is 1 day. The maximum is 90 days.
        Returns:
        the ttl

      • rotation

        public RotationPolicy rotation()
        Gets the rotation. This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types: username_password, private_cert, public_cert, iam_credentials, custom_credentials.
        Returns:
        the rotation

      • managedCsr

        public ImportedCertificateManagedCsr managedCsr()
        Gets the managedCsr. The data specified to create the CSR and the private key.
        Returns:
        the managedCsr

      • passwordGenerationPolicy

        public PasswordGenerationPolicyPatch passwordGenerationPolicy()
        Gets the passwordGenerationPolicy. Policy patch for auto-generated passwords. Policy properties that are included in the patch are updated. Properties that are not included in the patch remain unchanged.
        Returns:
        the passwordGenerationPolicy

      • parameters

        public Map<String,​Object> parameters()
        Gets the parameters. The parameters that are passed to custom credentials engine. Allowed types are 'string', 'integer' and 'boolean'.
        Returns:
        the parameters

      • asPatch

        public Map<String,​Object> asPatch()
        Construct a JSON merge-patch from the SecretMetadataPatch. Note that properties of the SecretMetadataPatch with null values are not represented in the constructed JSON merge-patch object, but can be explicitly set afterward to signify a property delete.
        Returns:
        a JSON merge-patch for the SecretMetadataPatch