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

Class SecretVersionMetadata

    • Method Detail

      • isAutoRotated

        public Boolean isAutoRotated()
        Gets the autoRotated. Indicates whether the version of the secret was created by automatic rotation.
        Returns:
        the autoRotated

      • getCreatedBy

        public String getCreatedBy()
        Gets the createdBy. The unique identifier that is associated with the entity that created the secret.
        Returns:
        the createdBy

      • getCreatedAt

        public Date getCreatedAt()
        Gets the createdAt. The date when the resource was created. The date format follows `RFC 3339`.
        Returns:
        the createdAt

      • isDownloaded

        public Boolean isDownloaded()
        Gets the downloaded. This field indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
        Returns:
        the downloaded

      • getId

        public String getId()
        Gets the id. A UUID identifier.
        Returns:
        the id

      • getSecretName

        public String getSecretName()
        Gets the secretName. The human-readable name of your secret.
        Returns:
        the secretName

      • getSecretType

        public String getSecretType()
        Gets the secretType. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
        Returns:
        the secretType

      • getSecretGroupId

        public String getSecretGroupId()
        Gets the secretGroupId. A UUID identifier, or `default` secret group.
        Returns:
        the secretGroupId

      • isPayloadAvailable

        public Boolean isPayloadAvailable()
        Gets the payloadAvailable. Indicates whether the secret payload is available in this secret version.
        Returns:
        the payloadAvailable

      • getAlias

        public String getAlias()
        Gets the alias. A human-readable alias that describes the secret version. 'Current' is used for version `n` and 'previous' is used for version `n-1`.
        Returns:
        the alias

      • getVersionCustomMetadata

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

      • getSecretId

        public String getSecretId()
        Gets the secretId. A UUID identifier.
        Returns:
        the secretId

      • getExpirationDate

        public Date getExpirationDate()
        Gets the expirationDate. The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types: arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, username_password, and custom_credentials.
        Returns:
        the expirationDate

      • getApiKeyId

        public String getApiKeyId()
        Gets the apiKeyId. The ID of the API key that is generated for this secret.
        Returns:
        the apiKeyId

      • getServiceId

        public String getServiceId()
        Gets the serviceId. The service ID under which the API key (see the `api_key` field) is created. If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation, and adds it to the access groups that you assign. Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the `access_groups` parameter.
        Returns:
        the serviceId

      • getSerialNumber

        public String getSerialNumber()
        Gets the serialNumber. The unique serial number that was assigned to a certificate by the issuing certificate authority.
        Returns:
        the serialNumber

      • getValidity

        public CertificateValidity getValidity()
        Gets the validity. The date and time that the certificate validity period begins and ends.
        Returns:
        the validity

      • getResourceKey

        public ServiceCredentialsResourceKey getResourceKey()
        Gets the resourceKey. The source service resource key data of the generated service credentials.
        Returns:
        the resourceKey

      • getCredentialsId

        public String getCredentialsId()
        Gets the credentialsId. Credentials created by the custom credentials system.
        Returns:
        the credentialsId