Package com.atlan.model.assets

Class AirflowTask

    • Method Detail

      • trimToReference

        public AirflowTask trimToReference()
                            throws InvalidRequestException
        Builds the minimal object necessary to create a relationship to a AirflowTask, from a potentially more-complete AirflowTask object.
        Specified by:
        trimToReference in class Asset
        Returns:
        the minimal object necessary to relate to the AirflowTask
        Throws:
        InvalidRequestException - if any of the minimal set of required properties for a AirflowTask relationship are not found in the initial object

      • select

        public static FluentSearch.FluentSearchBuilder<?,​?> select()
        Start a fluent search that will return all AirflowTask assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) AirflowTask assets will be included.
        Returns:
        a fluent search that includes all AirflowTask assets

      • select

        public static FluentSearch.FluentSearchBuilder<?,​?> select​(AtlanClient client)
        Start a fluent search that will return all AirflowTask assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) AirflowTask assets will be included.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the assets
        Returns:
        a fluent search that includes all AirflowTask assets

      • select

        public static FluentSearch.FluentSearchBuilder<?,​?> select​(boolean includeArchived)
        Start a fluent search that will return all AirflowTask assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
        Parameters:
        includeArchived - when true, archived (soft-deleted) AirflowTasks will be included
        Returns:
        a fluent search that includes all AirflowTask assets

      • select

        public static FluentSearch.FluentSearchBuilder<?,​?> select​(AtlanClient client,
                                                                 boolean includeArchived)
        Start a fluent search that will return all AirflowTask assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the assets
        includeArchived - when true, archived (soft-deleted) AirflowTasks will be included
        Returns:
        a fluent search that includes all AirflowTask assets

      • all

        @Deprecated
public static AssetFilter.AssetFilterBuilder all()
        Deprecated.
        replaced by select()
        Start an asset filter that will return all AirflowTask assets. Additional conditions can be chained onto the returned filter before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) AirflowTask assets will be included.
        Returns:
        an asset filter that includes all AirflowTask assets

      • all

        @Deprecated
public static AssetFilter.AssetFilterBuilder all​(AtlanClient client)
        Deprecated.
        replaced by select(AtlanClient)
        Start an asset filter that will return all AirflowTask assets. Additional conditions can be chained onto the returned filter before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) AirflowTask assets will be included.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the assets
        Returns:
        an asset filter that includes all AirflowTask assets

      • all

        @Deprecated
public static AssetFilter.AssetFilterBuilder all​(boolean includeArchived)
        Deprecated.
        replaced by select(boolean)
        Start an asset filter that will return all AirflowTask assets. Additional conditions can be chained onto the returned filter before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
        Parameters:
        includeArchived - when true, archived (soft-deleted) AirflowTasks will be included
        Returns:
        an asset filter that includes all AirflowTask assets

      • all

        @Deprecated
public static AssetFilter.AssetFilterBuilder all​(AtlanClient client,
                                                 boolean includeArchived)
        Deprecated.
        replaced by select(AtlanClient, boolean)
        Start an asset filter that will return all AirflowTask assets. Additional conditions can be chained onto the returned filter before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the assets
        includeArchived - when true, archived (soft-deleted) AirflowTasks will be included
        Returns:
        an asset filter that includes all AirflowTask assets

      • refByGuid

        public static AirflowTask refByGuid​(java.lang.String guid)
        Reference to a AirflowTask by GUID. Use this to create a relationship to this AirflowTask, where the relationship should be replaced.
        Parameters:
        guid - the GUID of the AirflowTask to reference
        Returns:
        reference to a AirflowTask that can be used for defining a relationship to a AirflowTask

      • refByGuid

        public static AirflowTask refByGuid​(java.lang.String guid,
                                    Reference.SaveSemantic semantic)
        Reference to a AirflowTask by GUID. Use this to create a relationship to this AirflowTask, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
        Parameters:
        guid - the GUID of the AirflowTask to reference
        semantic - how to save this relationship (replace all with this, append it, or remove it)
        Returns:
        reference to a AirflowTask that can be used for defining a relationship to a AirflowTask

      • refByQualifiedName

        public static AirflowTask refByQualifiedName​(java.lang.String qualifiedName)
        Reference to a AirflowTask by qualifiedName. Use this to create a relationship to this AirflowTask, where the relationship should be replaced.
        Parameters:
        qualifiedName - the qualifiedName of the AirflowTask to reference
        Returns:
        reference to a AirflowTask that can be used for defining a relationship to a AirflowTask

      • refByQualifiedName

        public static AirflowTask refByQualifiedName​(java.lang.String qualifiedName,
                                             Reference.SaveSemantic semantic)
        Reference to a AirflowTask by qualifiedName. Use this to create a relationship to this AirflowTask, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
        Parameters:
        qualifiedName - the qualifiedName of the AirflowTask to reference
        semantic - how to save this relationship (replace all with this, append it, or remove it)
        Returns:
        reference to a AirflowTask that can be used for defining a relationship to a AirflowTask

      • get

        public static AirflowTask get​(java.lang.String id)
                       throws AtlanException
        Retrieves a AirflowTask by one of its identifiers, complete with all of its relationships.
        Parameters:
        id - of the AirflowTask to retrieve, either its GUID or its full qualifiedName
        Returns:
        the requested full AirflowTask, complete with all of its relationships
        Throws:
        AtlanException - on any error during the API invocation, such as the NotFoundException if the AirflowTask does not exist or the provided GUID is not a AirflowTask

      • get

        public static AirflowTask get​(AtlanClient client,
                              java.lang.String id)
                       throws AtlanException
        Retrieves a AirflowTask by one of its identifiers, complete with all of its relationships.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the asset
        id - of the AirflowTask to retrieve, either its GUID or its full qualifiedName
        Returns:
        the requested full AirflowTask, complete with all of its relationships
        Throws:
        AtlanException - on any error during the API invocation, such as the NotFoundException if the AirflowTask does not exist or the provided GUID is not a AirflowTask

      • get

        public static AirflowTask get​(AtlanClient client,
                              java.lang.String id,
                              boolean includeRelationships)
                       throws AtlanException
        Retrieves a AirflowTask by one of its identifiers, optionally complete with all of its relationships.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the asset
        id - of the AirflowTask to retrieve, either its GUID or its full qualifiedName
        includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
        Returns:
        the requested full AirflowTask, optionally complete with all of its relationships
        Throws:
        AtlanException - on any error during the API invocation, such as the NotFoundException if the AirflowTask does not exist or the provided GUID is not a AirflowTask

      • retrieveByGuid

        @Deprecated
public static AirflowTask retrieveByGuid​(java.lang.String guid)
                                  throws AtlanException
        Deprecated.
        see get(String) instead
        Retrieves a AirflowTask by its GUID, complete with all of its relationships.
        Parameters:
        guid - of the AirflowTask to retrieve
        Returns:
        the requested full AirflowTask, complete with all of its relationships
        Throws:
        AtlanException - on any error during the API invocation, such as the NotFoundException if the AirflowTask does not exist or the provided GUID is not a AirflowTask

      • retrieveByGuid

        @Deprecated
public static AirflowTask retrieveByGuid​(AtlanClient client,
                                         java.lang.String guid)
                                  throws AtlanException
        Deprecated.
        see get(AtlanClient, String) instead
        Retrieves a AirflowTask by its GUID, complete with all of its relationships.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the asset
        guid - of the AirflowTask to retrieve
        Returns:
        the requested full AirflowTask, complete with all of its relationships
        Throws:
        AtlanException - on any error during the API invocation, such as the NotFoundException if the AirflowTask does not exist or the provided GUID is not a AirflowTask

      • retrieveByQualifiedName

        @Deprecated
public static AirflowTask retrieveByQualifiedName​(java.lang.String qualifiedName)
                                           throws AtlanException
        Deprecated.
        see get(String) instead
        Retrieves a AirflowTask by its qualifiedName, complete with all of its relationships.
        Parameters:
        qualifiedName - of the AirflowTask to retrieve
        Returns:
        the requested full AirflowTask, complete with all of its relationships
        Throws:
        AtlanException - on any error during the API invocation, such as the NotFoundException if the AirflowTask does not exist

      • retrieveByQualifiedName

        @Deprecated
public static AirflowTask retrieveByQualifiedName​(AtlanClient client,
                                                  java.lang.String qualifiedName)
                                           throws AtlanException
        Deprecated.
        see get(AtlanClient, String) instead
        Retrieves a AirflowTask by its qualifiedName, complete with all of its relationships.
        Parameters:
        client - connectivity to the Atlan tenant from which to retrieve the asset
        qualifiedName - of the AirflowTask to retrieve
        Returns:
        the requested full AirflowTask, complete with all of its relationships
        Throws:
        AtlanException - on any error during the API invocation, such as the NotFoundException if the AirflowTask does not exist

      • restore

        public static boolean restore​(java.lang.String qualifiedName)
                       throws AtlanException
        Restore the archived (soft-deleted) AirflowTask to active.
        Parameters:
        qualifiedName - for the AirflowTask
        Returns:
        true if the AirflowTask is now active, and false otherwise
        Throws:
        AtlanException - on any API problems

      • restore

        public static boolean restore​(AtlanClient client,
                              java.lang.String qualifiedName)
                       throws AtlanException
        Restore the archived (soft-deleted) AirflowTask to active.
        Parameters:
        client - connectivity to the Atlan tenant on which to restore the asset
        qualifiedName - for the AirflowTask
        Returns:
        true if the AirflowTask is now active, and false otherwise
        Throws:
        AtlanException - on any API problems

      • creator

        public static AirflowTask.AirflowTaskBuilder<?,​?> creator​(java.lang.String name,
                                                                AirflowDag airflowDag)
                                                         throws InvalidRequestException
        Builds the minimal object necessary to create an AirflowTask.
        Parameters:
        name - of the AirflowTask
        airflowDag - in which the AirflowTask should be created, which must have at least a qualifiedName
        Returns:
        the minimal request necessary to create the AirflowTask, as a builder
        Throws:
        InvalidRequestException - if the AirflowDag provided is without a qualifiedName

      • creator

        public static AirflowTask.AirflowTaskBuilder<?,​?> creator​(java.lang.String name,
                                                                java.lang.String airflowDagQualifiedName)
        Builds the minimal object necessary to create an AirflowTask.
        Parameters:
        name - of the AirflowTask
        airflowDagQualifiedName - unique name of the DAG through which the task is accessible
        Returns:
        the minimal object necessary to create the AirflowTask, as a builder

      • updater

        public static AirflowTask.AirflowTaskBuilder<?,​?> updater​(java.lang.String qualifiedName,
                                                                java.lang.String name)
        Builds the minimal object necessary to update a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the minimal request necessary to update the AirflowTask, as a builder

      • trimToRequired

        public AirflowTask.AirflowTaskBuilder<?,​?> trimToRequired()
                                                         throws InvalidRequestException
        Builds the minimal object necessary to apply an update to a AirflowTask, from a potentially more-complete AirflowTask object.
        Specified by:
        trimToRequired in class Asset
        Returns:
        the minimal object necessary to update the AirflowTask, as a builder
        Throws:
        InvalidRequestException - if any of the minimal set of required properties for AirflowTask are not found in the initial object

      • removeDescription

        public static AirflowTask removeDescription​(java.lang.String qualifiedName,
                                            java.lang.String name)
                                     throws AtlanException
        Remove the system description from a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • removeDescription

        public static AirflowTask removeDescription​(AtlanClient client,
                                            java.lang.String qualifiedName,
                                            java.lang.String name)
                                     throws AtlanException
        Remove the system description from a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant on which to remove the asset's description
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • removeUserDescription

        public static AirflowTask removeUserDescription​(java.lang.String qualifiedName,
                                                java.lang.String name)
                                         throws AtlanException
        Remove the user's description from a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • removeUserDescription

        public static AirflowTask removeUserDescription​(AtlanClient client,
                                                java.lang.String qualifiedName,
                                                java.lang.String name)
                                         throws AtlanException
        Remove the user's description from a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant on which to remove the asset's description
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • removeOwners

        public static AirflowTask removeOwners​(java.lang.String qualifiedName,
                                       java.lang.String name)
                                throws AtlanException
        Remove the owners from a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • removeOwners

        public static AirflowTask removeOwners​(AtlanClient client,
                                       java.lang.String qualifiedName,
                                       java.lang.String name)
                                throws AtlanException
        Remove the owners from a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant from which to remove the AirflowTask's owners
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • updateCertificate

        public static AirflowTask updateCertificate​(java.lang.String qualifiedName,
                                            CertificateStatus certificate,
                                            java.lang.String message)
                                     throws AtlanException
        Update the certificate on a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        certificate - to use
        message - (optional) message, or null if no message
        Returns:
        the updated AirflowTask, or null if the update failed
        Throws:
        AtlanException - on any API problems

      • updateCertificate

        public static AirflowTask updateCertificate​(AtlanClient client,
                                            java.lang.String qualifiedName,
                                            CertificateStatus certificate,
                                            java.lang.String message)
                                     throws AtlanException
        Update the certificate on a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant on which to update the AirflowTask's certificate
        qualifiedName - of the AirflowTask
        certificate - to use
        message - (optional) message, or null if no message
        Returns:
        the updated AirflowTask, or null if the update failed
        Throws:
        AtlanException - on any API problems

      • removeCertificate

        public static AirflowTask removeCertificate​(java.lang.String qualifiedName,
                                            java.lang.String name)
                                     throws AtlanException
        Remove the certificate from a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • removeCertificate

        public static AirflowTask removeCertificate​(AtlanClient client,
                                            java.lang.String qualifiedName,
                                            java.lang.String name)
                                     throws AtlanException
        Remove the certificate from a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant from which to remove the AirflowTask's certificate
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • updateAnnouncement

        public static AirflowTask updateAnnouncement​(java.lang.String qualifiedName,
                                             AtlanAnnouncementType type,
                                             java.lang.String title,
                                             java.lang.String message)
                                      throws AtlanException
        Update the announcement on a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        type - type of announcement to set
        title - (optional) title of the announcement to set (or null for no title)
        message - (optional) message of the announcement to set (or null for no message)
        Returns:
        the result of the update, or null if the update failed
        Throws:
        AtlanException - on any API problems

      • updateAnnouncement

        public static AirflowTask updateAnnouncement​(AtlanClient client,
                                             java.lang.String qualifiedName,
                                             AtlanAnnouncementType type,
                                             java.lang.String title,
                                             java.lang.String message)
                                      throws AtlanException
        Update the announcement on a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant on which to update the AirflowTask's announcement
        qualifiedName - of the AirflowTask
        type - type of announcement to set
        title - (optional) title of the announcement to set (or null for no title)
        message - (optional) message of the announcement to set (or null for no message)
        Returns:
        the result of the update, or null if the update failed
        Throws:
        AtlanException - on any API problems

      • removeAnnouncement

        public static AirflowTask removeAnnouncement​(java.lang.String qualifiedName,
                                             java.lang.String name)
                                      throws AtlanException
        Remove the announcement from a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • removeAnnouncement

        public static AirflowTask removeAnnouncement​(AtlanClient client,
                                             java.lang.String qualifiedName,
                                             java.lang.String name)
                                      throws AtlanException
        Remove the announcement from a AirflowTask.
        Parameters:
        client - connectivity to the Atlan client from which to remove the AirflowTask's announcement
        qualifiedName - of the AirflowTask
        name - of the AirflowTask
        Returns:
        the updated AirflowTask, or null if the removal failed
        Throws:
        AtlanException - on any API problems

      • replaceTerms

        public static AirflowTask replaceTerms​(java.lang.String qualifiedName,
                                       java.lang.String name,
                                       java.util.List<IGlossaryTerm> terms)
                                throws AtlanException
        Replace the terms linked to the AirflowTask.
        Parameters:
        qualifiedName - for the AirflowTask
        name - human-readable name of the AirflowTask
        terms - the list of terms to replace on the AirflowTask, or null to remove all terms from the AirflowTask
        Returns:
        the AirflowTask that was updated (note that it will NOT contain details of the replaced terms)
        Throws:
        AtlanException - on any API problems

      • replaceTerms

        public static AirflowTask replaceTerms​(AtlanClient client,
                                       java.lang.String qualifiedName,
                                       java.lang.String name,
                                       java.util.List<IGlossaryTerm> terms)
                                throws AtlanException
        Replace the terms linked to the AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant on which to replace the AirflowTask's assigned terms
        qualifiedName - for the AirflowTask
        name - human-readable name of the AirflowTask
        terms - the list of terms to replace on the AirflowTask, or null to remove all terms from the AirflowTask
        Returns:
        the AirflowTask that was updated (note that it will NOT contain details of the replaced terms)
        Throws:
        AtlanException - on any API problems

      • appendTerms

        public static AirflowTask appendTerms​(java.lang.String qualifiedName,
                                      java.util.List<IGlossaryTerm> terms)
                               throws AtlanException
        Link additional terms to the AirflowTask, without replacing existing terms linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing terms, and a second to append the new terms.
        Parameters:
        qualifiedName - for the AirflowTask
        terms - the list of terms to append to the AirflowTask
        Returns:
        the AirflowTask that was updated (note that it will NOT contain details of the appended terms)
        Throws:
        AtlanException - on any API problems

      • appendTerms

        public static AirflowTask appendTerms​(AtlanClient client,
                                      java.lang.String qualifiedName,
                                      java.util.List<IGlossaryTerm> terms)
                               throws AtlanException
        Link additional terms to the AirflowTask, without replacing existing terms linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing terms, and a second to append the new terms.
        Parameters:
        client - connectivity to the Atlan tenant on which to append terms to the AirflowTask
        qualifiedName - for the AirflowTask
        terms - the list of terms to append to the AirflowTask
        Returns:
        the AirflowTask that was updated (note that it will NOT contain details of the appended terms)
        Throws:
        AtlanException - on any API problems

      • removeTerms

        public static AirflowTask removeTerms​(java.lang.String qualifiedName,
                                      java.util.List<IGlossaryTerm> terms)
                               throws AtlanException
        Remove terms from a AirflowTask, without replacing all existing terms linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing terms, and a second to remove the provided terms.
        Parameters:
        qualifiedName - for the AirflowTask
        terms - the list of terms to remove from the AirflowTask, which must be referenced by GUID
        Returns:
        the AirflowTask that was updated (note that it will NOT contain details of the resulting terms)
        Throws:
        AtlanException - on any API problems

      • removeTerms

        public static AirflowTask removeTerms​(AtlanClient client,
                                      java.lang.String qualifiedName,
                                      java.util.List<IGlossaryTerm> terms)
                               throws AtlanException
        Remove terms from a AirflowTask, without replacing all existing terms linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing terms, and a second to remove the provided terms.
        Parameters:
        client - connectivity to the Atlan tenant from which to remove terms from the AirflowTask
        qualifiedName - for the AirflowTask
        terms - the list of terms to remove from the AirflowTask, which must be referenced by GUID
        Returns:
        the AirflowTask that was updated (note that it will NOT contain details of the resulting terms)
        Throws:
        AtlanException - on any API problems

      • appendAtlanTags

        public static AirflowTask appendAtlanTags​(java.lang.String qualifiedName,
                                          java.util.List<java.lang.String> atlanTagNames)
                                   throws AtlanException
        Add Atlan tags to a AirflowTask, without replacing existing Atlan tags linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing Atlan tags, and a second to append the new Atlan tags.
        Parameters:
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        Returns:
        the updated AirflowTask
        Throws:
        AtlanException - on any API problems

      • appendAtlanTags

        public static AirflowTask appendAtlanTags​(AtlanClient client,
                                          java.lang.String qualifiedName,
                                          java.util.List<java.lang.String> atlanTagNames)
                                   throws AtlanException
        Add Atlan tags to a AirflowTask, without replacing existing Atlan tags linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing Atlan tags, and a second to append the new Atlan tags.
        Parameters:
        client - connectivity to the Atlan tenant on which to append Atlan tags to the AirflowTask
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        Returns:
        the updated AirflowTask
        Throws:
        AtlanException - on any API problems

      • appendAtlanTags

        public static AirflowTask appendAtlanTags​(java.lang.String qualifiedName,
                                          java.util.List<java.lang.String> atlanTagNames,
                                          boolean propagate,
                                          boolean removePropagationsOnDelete,
                                          boolean restrictLineagePropagation)
                                   throws AtlanException
        Add Atlan tags to a AirflowTask, without replacing existing Atlan tags linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing Atlan tags, and a second to append the new Atlan tags.
        Parameters:
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        propagate - whether to propagate the Atlan tag (true) or not (false)
        removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
        restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
        Returns:
        the updated AirflowTask
        Throws:
        AtlanException - on any API problems

      • appendAtlanTags

        public static AirflowTask appendAtlanTags​(AtlanClient client,
                                          java.lang.String qualifiedName,
                                          java.util.List<java.lang.String> atlanTagNames,
                                          boolean propagate,
                                          boolean removePropagationsOnDelete,
                                          boolean restrictLineagePropagation)
                                   throws AtlanException
        Add Atlan tags to a AirflowTask, without replacing existing Atlan tags linked to the AirflowTask. Note: this operation must make two API calls — one to retrieve the AirflowTask's existing Atlan tags, and a second to append the new Atlan tags.
        Parameters:
        client - connectivity to the Atlan tenant on which to append Atlan tags to the AirflowTask
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        propagate - whether to propagate the Atlan tag (true) or not (false)
        removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
        restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
        Returns:
        the updated AirflowTask
        Throws:
        AtlanException - on any API problems

      • addAtlanTags

        @Deprecated
public static void addAtlanTags​(java.lang.String qualifiedName,
                                java.util.List<java.lang.String> atlanTagNames)
                         throws AtlanException
        Deprecated.
        see appendAtlanTags(String, List) instead
        Add Atlan tags to a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        Throws:
        AtlanException - on any API problems, or if any of the Atlan tags already exist on the AirflowTask

      • addAtlanTags

        @Deprecated
public static void addAtlanTags​(AtlanClient client,
                                java.lang.String qualifiedName,
                                java.util.List<java.lang.String> atlanTagNames)
                         throws AtlanException
        Deprecated.
        see appendAtlanTags(String, List) instead
        Add Atlan tags to a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant on which to add Atlan tags to the AirflowTask
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        Throws:
        AtlanException - on any API problems, or if any of the Atlan tags already exist on the AirflowTask

      • addAtlanTags

        @Deprecated
public static void addAtlanTags​(java.lang.String qualifiedName,
                                java.util.List<java.lang.String> atlanTagNames,
                                boolean propagate,
                                boolean removePropagationsOnDelete,
                                boolean restrictLineagePropagation)
                         throws AtlanException
        Deprecated.
        see appendAtlanTags(String, List, boolean, boolean, boolean) instead
        Add Atlan tags to a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        propagate - whether to propagate the Atlan tag (true) or not (false)
        removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
        restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
        Throws:
        AtlanException - on any API problems, or if any of the Atlan tags already exist on the AirflowTask

      • addAtlanTags

        @Deprecated
public static void addAtlanTags​(AtlanClient client,
                                java.lang.String qualifiedName,
                                java.util.List<java.lang.String> atlanTagNames,
                                boolean propagate,
                                boolean removePropagationsOnDelete,
                                boolean restrictLineagePropagation)
                         throws AtlanException
        Deprecated.
        see appendAtlanTags(String, List, boolean, boolean, boolean) instead
        Add Atlan tags to a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant on which to add Atlan tags to the AirflowTask
        qualifiedName - of the AirflowTask
        atlanTagNames - human-readable names of the Atlan tags to add
        propagate - whether to propagate the Atlan tag (true) or not (false)
        removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
        restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
        Throws:
        AtlanException - on any API problems, or if any of the Atlan tags already exist on the AirflowTask

      • removeAtlanTag

        public static void removeAtlanTag​(java.lang.String qualifiedName,
                                  java.lang.String atlanTagName)
                           throws AtlanException
        Remove an Atlan tag from a AirflowTask.
        Parameters:
        qualifiedName - of the AirflowTask
        atlanTagName - human-readable name of the Atlan tag to remove
        Throws:
        AtlanException - on any API problems, or if the Atlan tag does not exist on the AirflowTask

      • removeAtlanTag

        public static void removeAtlanTag​(AtlanClient client,
                                  java.lang.String qualifiedName,
                                  java.lang.String atlanTagName)
                           throws AtlanException
        Remove an Atlan tag from a AirflowTask.
        Parameters:
        client - connectivity to the Atlan tenant from which to remove an Atlan tag from a AirflowTask
        qualifiedName - of the AirflowTask
        atlanTagName - human-readable name of the Atlan tag to remove
        Throws:
        AtlanException - on any API problems, or if the Atlan tag does not exist on the AirflowTask

      • getAirflowDagName

        public java.lang.String getAirflowDagName()
        Simple name of the DAG this task is contained within.
        Specified by:
        getAirflowDagName in interface IAirflowTask

      • getAirflowDagQualifiedName

        public java.lang.String getAirflowDagQualifiedName()
        Unique name of the DAG this task is contained within.
        Specified by:
        getAirflowDagQualifiedName in interface IAirflowTask

      • getAirflowTaskConnectionId

        public java.lang.String getAirflowTaskConnectionId()
        Identifier for the connection this task accesses.
        Specified by:
        getAirflowTaskConnectionId in interface IAirflowTask

      • getAirflowTaskOperatorClass

        public java.lang.String getAirflowTaskOperatorClass()
        Class name for the operator this task uses.
        Specified by:
        getAirflowTaskOperatorClass in interface IAirflowTask

      • getAirflowTaskPool

        public java.lang.String getAirflowTaskPool()
        Pool on which this run happened.
        Specified by:
        getAirflowTaskPool in interface IAirflowTask

      • getAirflowTaskQueue

        public java.lang.String getAirflowTaskQueue()
        Queue on which this run happened.
        Specified by:
        getAirflowTaskQueue in interface IAirflowTask

      • getAirflowTaskSql

        public java.lang.String getAirflowTaskSql()
        SQL code that executes through this task.
        Specified by:
        getAirflowTaskSql in interface IAirflowTask

      • getInputs

        public java.util.SortedSet<ICatalog> getInputs()
        Assets that are inputs to this task.
        Specified by:
        getInputs in interface IAirflowTask

      • getOutputs

        public java.util.SortedSet<ICatalog> getOutputs()
        Assets that are outputs from this task.
        Specified by:
        getOutputs in interface IAirflowTask

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class Asset

      • canEqual

        protected boolean canEqual​(java.lang.Object other)
        Overrides:
        canEqual in class Asset

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Asset

      • toString

        public java.lang.String toString()
        Description copied from class: AtlanObject
        Overrides:
        toString in class Asset