Class KeyMetadata

    • Constructor Detail

      • KeyMetadata

        public KeyMetadata()
      • KeyMetadata

        public KeyMetadata​(KeyMetadata source)
        NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
    • Method Detail

      • getKeyId

        public String getKeyId()
        Get CMK的全局唯一标识
        Returns:
        KeyId CMK的全局唯一标识
      • setKeyId

        public void setKeyId​(String KeyId)
        Set CMK的全局唯一标识
        Parameters:
        KeyId - CMK的全局唯一标识
      • getAlias

        public String getAlias()
        Get 作为密钥更容易辨识,更容易被人看懂的别名
        Returns:
        Alias 作为密钥更容易辨识,更容易被人看懂的别名
      • setAlias

        public void setAlias​(String Alias)
        Set 作为密钥更容易辨识,更容易被人看懂的别名
        Parameters:
        Alias - 作为密钥更容易辨识,更容易被人看懂的别名
      • getCreateTime

        public Long getCreateTime()
        Get 密钥创建时间
        Returns:
        CreateTime 密钥创建时间
      • setCreateTime

        public void setCreateTime​(Long CreateTime)
        Set 密钥创建时间
        Parameters:
        CreateTime - 密钥创建时间
      • getDescription

        public String getDescription()
        Get CMK的描述
        Returns:
        Description CMK的描述
      • setDescription

        public void setDescription​(String Description)
        Set CMK的描述
        Parameters:
        Description - CMK的描述
      • getKeyState

        public String getKeyState()
        Get CMK的状态, 取值为:Enabled | Disabled | PendingDelete | PendingImport | Archived
        Returns:
        KeyState CMK的状态, 取值为:Enabled | Disabled | PendingDelete | PendingImport | Archived
      • setKeyState

        public void setKeyState​(String KeyState)
        Set CMK的状态, 取值为:Enabled | Disabled | PendingDelete | PendingImport | Archived
        Parameters:
        KeyState - CMK的状态, 取值为:Enabled | Disabled | PendingDelete | PendingImport | Archived
      • getKeyUsage

        public String getKeyUsage()
        Get CMK用途,取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC
        Returns:
        KeyUsage CMK用途,取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC
      • setKeyUsage

        public void setKeyUsage​(String KeyUsage)
        Set CMK用途,取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC
        Parameters:
        KeyUsage - CMK用途,取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC
      • getType

        public Long getType()
        Get CMK类型,2 表示符合FIPS标准,4表示符合国密标准
        Returns:
        Type CMK类型,2 表示符合FIPS标准,4表示符合国密标准
      • setType

        public void setType​(Long Type)
        Set CMK类型,2 表示符合FIPS标准,4表示符合国密标准
        Parameters:
        Type - CMK类型,2 表示符合FIPS标准,4表示符合国密标准
      • getCreatorUin

        public Long getCreatorUin()
        Get 创建者
        Returns:
        CreatorUin 创建者
      • setCreatorUin

        public void setCreatorUin​(Long CreatorUin)
        Set 创建者
        Parameters:
        CreatorUin - 创建者
      • getKeyRotationEnabled

        public Boolean getKeyRotationEnabled()
        Get 是否开启了密钥轮换功能
        Returns:
        KeyRotationEnabled 是否开启了密钥轮换功能
      • setKeyRotationEnabled

        public void setKeyRotationEnabled​(Boolean KeyRotationEnabled)
        Set 是否开启了密钥轮换功能
        Parameters:
        KeyRotationEnabled - 是否开启了密钥轮换功能
      • getOwner

        public String getOwner()
        Get CMK的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名
        Returns:
        Owner CMK的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名
      • setOwner

        public void setOwner​(String Owner)
        Set CMK的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名
        Parameters:
        Owner - CMK的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名
      • getNextRotateTime

        public Long getNextRotateTime()
        Get 在密钥轮换开启状态下,下次轮换的时间
        Returns:
        NextRotateTime 在密钥轮换开启状态下,下次轮换的时间
      • setNextRotateTime

        public void setNextRotateTime​(Long NextRotateTime)
        Set 在密钥轮换开启状态下,下次轮换的时间
        Parameters:
        NextRotateTime - 在密钥轮换开启状态下,下次轮换的时间
      • getDeletionDate

        public Long getDeletionDate()
        Get 计划删除的时间 注意:此字段可能返回 null,表示取不到有效值。
        Returns:
        DeletionDate 计划删除的时间 注意:此字段可能返回 null,表示取不到有效值。
      • setDeletionDate

        public void setDeletionDate​(Long DeletionDate)
        Set 计划删除的时间 注意:此字段可能返回 null,表示取不到有效值。
        Parameters:
        DeletionDate - 计划删除的时间 注意:此字段可能返回 null,表示取不到有效值。
      • getOrigin

        public String getOrigin()
        Get CMK 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL 注意:此字段可能返回 null,表示取不到有效值。
        Returns:
        Origin CMK 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL 注意:此字段可能返回 null,表示取不到有效值。
      • setOrigin

        public void setOrigin​(String Origin)
        Set CMK 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL 注意:此字段可能返回 null,表示取不到有效值。
        Parameters:
        Origin - CMK 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL 注意:此字段可能返回 null,表示取不到有效值。
      • getValidTo

        public Long getValidTo()
        Get 在Origin为 EXTERNAL 时有效,表示密钥材料的有效日期, 0 表示不过期 注意:此字段可能返回 null,表示取不到有效值。
        Returns:
        ValidTo 在Origin为 EXTERNAL 时有效,表示密钥材料的有效日期, 0 表示不过期 注意:此字段可能返回 null,表示取不到有效值。
      • setValidTo

        public void setValidTo​(Long ValidTo)
        Set 在Origin为 EXTERNAL 时有效,表示密钥材料的有效日期, 0 表示不过期 注意:此字段可能返回 null,表示取不到有效值。
        Parameters:
        ValidTo - 在Origin为 EXTERNAL 时有效,表示密钥材料的有效日期, 0 表示不过期 注意:此字段可能返回 null,表示取不到有效值。
      • getResourceId

        public String getResourceId()
        Get 资源ID,格式:creatorUin/$creatorUin/$keyId
        Returns:
        ResourceId 资源ID,格式:creatorUin/$creatorUin/$keyId
      • setResourceId

        public void setResourceId​(String ResourceId)
        Set 资源ID,格式:creatorUin/$creatorUin/$keyId
        Parameters:
        ResourceId - 资源ID,格式:creatorUin/$creatorUin/$keyId
      • getHsmClusterId

        public String getHsmClusterId()
        Get HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效) 注意:此字段可能返回 null,表示取不到有效值。
        Returns:
        HsmClusterId HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效) 注意:此字段可能返回 null,表示取不到有效值。
      • setHsmClusterId

        public void setHsmClusterId​(String HsmClusterId)
        Set HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效) 注意:此字段可能返回 null,表示取不到有效值。
        Parameters:
        HsmClusterId - HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效) 注意:此字段可能返回 null,表示取不到有效值。