Certify assets

Add to an existing asset

1.4.0 1.0.0

To add a certificate to an existing asset:

dbt Java Python Kotlin Raw REST API

models:
  - name: TOP_BEVERAGE_USERS # (1)
    meta:
      atlan:
        attributes: # (2)
          certificateStatus: VERIFIED # (3)
          certificateStatusMessage: >- # (4)
            Verified through automation.

1. You must of course give the name of the object.
2. The details for the certificate must be nested within the meta.atlan.attributes structure.
3. You must provide a valid status for the certificate (DRAFT, VERIFIED or DEPRECATED).
4. (Optional) You can also provide a message to associate with the certificate.

Table result = Table.updateCertificate( // (1)
    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", // (2)
    CertificateStatus.VERIFIED, // (3)
    "Verified through automation."); // (4)

1. Use the updateCertificate() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request, call the necessary API(s), and return with the result of the update operation all-in-one.
2. The qualifiedName of the object.
3. The type of certificate (the CertificateStatus enumeration gives the valid values).
4. (Optional) A message to include in the certificate.

from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Table
from pyatlan.model.enums import CertificateStatus

client = AtlanClient()
table = client.asset.update_certificate( # (1)
    asset_type=Table,
    qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    name="TOP_BEVERAGE_USERS",
    certificate_status=CertificateStatus.VERIFIED,
    message="Verified through automation.",
)
if table is None: # (2)
    print("Certificate status did not change")
else: # (3)
    print("Certificate status updated")

1. Use the asset.update_certificate() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request, call the necessary API(s), and return with the result of the update operation all-in-one.
2. If no change occurs to the asset then None will be returned.
3. If the asset is updated then the asset will be returned.

val result = Table.updateCertificate(  // (1)
    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",  // (2)
    CertificateStatus.VERIFIED,  // (3)
    "Verified through automation.")  // (4)

1. Use the updateCertificate() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request, call the necessary API(s), and return with the result of the update operation all-in-one.
2. The qualifiedName of the object.
3. The type of certificate (the CertificateStatus enumeration gives the valid values).
4. (Optional) A message to include in the certificate.

{
  "entities": [ // (1)
    {
      "typeName": "Table", // (2)
      "attributes": {
        "name": "TOP_BEVERAGE_USERS", // (3)
        "qualifiedName": "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", // (4)
        "certificateStatus": "VERIFIED", // (5)
        "certificateStatusMessage": "Verified through automation." // (6)
      }
    }
  ]
}

1. All assets must be wrapped in an entities array.
2. You must provide the exact type name for the asset (case-sensitive).
3. You must provide the exact name of the asset (case-sensitive).
4. You must provide the exact qualifiedName of the asset (case-sensitive).
5. You must provide a valid status for the certificate.
6. (Optional) You can also provide a status message for the certificate.

Remove from an existing asset

1.4.0 1.0.0

To remove a certificate from an existing asset:

dbt Java Python Kotlin Raw REST API

It is currently not possible to remove a certificate from an asset via dbt.

Column column = Column.removeCertificate( // (1)
    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS/USER_ID", // (2)
    "USER_ID"); // (3)

1. Use the removeCertificate() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request, call the necessary API(s), and return with the result of the removal operation all-in-one.
2. The qualifiedName of the column (this is generally needed on all assets).
3. The name of the column (this varies by asset, but most assets need the name specified).

from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Column

client = AtlanClient()
column = client.asset.remove_certificate( # (1)
    asset_type=Column,
    qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS/USER_ID",
    name="USER_ID",
)
if column is None: # (2)
    print("Certificate was not present")
else: # (3)
    print("Certificate was removed")

1. Use the asset.remove_certificate() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request, call the necessary API(s), and return with the result of the removal operation all-in-one.
2. If no change occurs to the asset because the certificate is not present then None will be returned.
3. If certificate is removed from the asset then the asset will be returned.

val column = Column.removeCertificate(  // (1)
    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS/USER_ID",  // (2)
    "USER_ID")  // (3)

1. Use the removeCertificate() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request, call the necessary API(s), and return with the result of the removal operation all-in-one.
2. The qualifiedName of the column (this is generally needed on all assets).
3. The name of the column (this varies by asset, but most assets need the name specified).

{
  "entities": [ // (1)
    {
      "typeName": "Table", // (2)
      "attributes": {
        "name": "USER_ID", // (3)
        "qualifiedName": "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS/USER_ID", // (4)
        "certificateStatus": null, // (5)
        "certificateStatusMessage": null
      }
    }
  ]
}

1. All assets must be wrapped in an entities array.
2. You must provide the exact type name for the asset (case-sensitive).
3. You must provide the exact name of the asset (case-sensitive).
4. You must provide the exact qualifiedName of the asset (case-sensitive).
5. To remove the certificate, set its status and message to null.

When creating an asset

2.0.0 1.0.0

To add a certificate when creating an asset:

dbt Java Python Kotlin Raw REST API

models:
  - name: TOP_BEVERAGE_USERS # (1)
    meta:
      atlan:
        attributes: # (2)
          certificateStatus: VERIFIED # (3)
          certificateStatusMessage: >- # (4)
            Verified at creation.

1. You must of course give the name of the object.
2. The details for the certificate must be nested within the meta.atlan.attributes structure.
3. You must provide a valid status for the certificate (DRAFT, VERIFIED or DEPRECATED).
4. (Optional) You can also provide a message to associate with the certificate.

Table table = Table
    .creator("TOP_BEVERAGE_USERS", // (1)
        "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV")
    .certificateStatus(CertificateStatus.VERIFIED) // (2)
    .certificateStatusMessage("Verified at creation.") // (3)
    .build(); // (4)
AssetMutationResponse response = table.save(); // (5)
assert response.getCreatedAssets().size() == 1 // (6)

1. Use the creator() method to initialize the object with all necessary attributes for creating it.
2. Set the certificate that should be added (in this example, we're using VERIFIED).
3. (Optional) Add a message for the certificate.
4. Call the build() method to build the enriched object.
5. Call the save() method to actually create the asset with this certificate.
6. The response will include that single asset that was created.

from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Table
from pyatlan.model.enums import CertificateStatus


client = AtlanClient()
table = Table.creator(  # (1)
    name="TOP_BEVERAGE_USERS",
    schema_qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV",
)
table.certificate_status = CertificateStatus.VERIFIED # (2)
table.certificate_status_message = "Verified at creation." # (3)
response = client.asset.save(table)  # (4)
assert response.assets_created(Table)  # (5)
table = response.assets_created(Table)[0]  # (6)

1. Use the create() method to initialize the object with all necessary attributes for creating it.
2. Set the certificate that should be added (in this example, we're using VERIFIED).
3. (Optional) Add a message for the certificate.
4. Invoke the save() method with asset. This method will return an AssetMutationResponse object that encapsulates the results.
5. Since a save can add, update, delete or partially update multiple assets the assets_created() method can be used to return a list of the assets of the specified type that were added. The assert statement is present to ensure a Table asset was created.
6. Since only one Table should have been created we use an index of 0 to retrieve the newly created table.

val table: Table = Table
    .creator("TOP_BEVERAGE_USERS",  // (1)
        "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV")
    .certificateStatus(CertificateStatus.VERIFIED)  // (2)
    .certificateStatusMessage("Verified at creation.")  // (3)
    .build()  // (4)
val response = table.save()  // (5)
assert(response.createdAssets.size == 1)  // (6)

1. Use the creator() method to initialize the object with all necessary attributes for creating it.
2. Set the certificate that should be added (in this example, we're using VERIFIED).
3. (Optional) Add a message for the certificate.
4. Call the build() method to build the enriched object.
5. Call the save() method to actually create the asset with this certificate.
6. The response will include that single asset that was created.

{
  "entities": [ // (1)
    {
      "typeName": "Table", // (2)
      "attributes": {
        "name": "TOP_BEVERAGE_USERS", // (3)
        "qualifiedName": "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", // (4)
        "atlanSchema": { // (5)
          "typeName": "Schema",
          "uniqueAttributes": {
            "qualifiedName": "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV"
          }
        },
        "certificateStatus": "VERIFIED", // (6)
        "certificateStatusMessage": "Verified at creation." // (7)
      }
    }
  ]
}

1. All assets must be wrapped in an entities array.
2. You must provide the exact type name for the asset (case-sensitive).
3. You must provide a name for the asset.
4. In the case of a table, the qualifiedName must be the concatenation of the parent schema's qualifiedName and the name of the table.
5. When creating a table, you must specify the schema to create it within. This is defined by the atlanSchema attribute. You must specify both the type (must be Schema) and qualifiedName of the schema within the atlanSchema attribute — and the schema must already exist.
6. You must provide a valid status for the certificate.
7. (Optional) You can also provide a status message for the certificate.

---