com.atlan.model.assets.ITableauField Maven / Gradle / Ivy
/* SPDX-License-Identifier: Apache-2.0
Copyright 2023 Atlan Pte. Ltd. */
package com.atlan.model.assets;
import com.atlan.model.enums.AtlanAnnouncementType;
import com.atlan.model.enums.AtlanConnectorType;
import com.atlan.model.enums.AtlanStatus;
import com.atlan.model.enums.CertificateStatus;
import com.atlan.model.enums.SourceCostUnitType;
import com.atlan.model.relations.RelationshipAttributes;
import com.atlan.model.relations.UniqueAttributes;
import com.atlan.model.structs.PopularityInsights;
import com.atlan.serde.AssetDeserializer;
import com.atlan.serde.AssetSerializer;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
/**
* Instance of a Tableau calculated or datasource field in Atlan.
* (Note that this is necessary, and not generated, to cater for the attribute 'fields' on
* TableauDatasource that can refer to either of these types of Tableau fields, through two
* different RelationshipDefs that use the same endpoint name 'fields' and thus cause an overload
* of the attribute name.)
*/
@JsonSerialize(using = AssetSerializer.class)
@JsonDeserialize(using = AssetDeserializer.class)
public interface ITableauField {
/** TBC */
SortedSet getAdminGroups();
/** TBC */
SortedSet getAdminRoles();
/** TBC */
SortedSet getAdminUsers();
/** TBC */
String getAnnouncementMessage();
/** TBC */
String getAnnouncementTitle();
/** TBC */
AtlanAnnouncementType getAnnouncementType();
/** TBC */
Long getAnnouncementUpdatedAt();
/** TBC */
String getAnnouncementUpdatedBy();
/** TBC */
String getAssetDbtAccountName();
/** TBC */
String getAssetDbtAlias();
/** TBC */
String getAssetDbtEnvironmentDbtVersion();
/** TBC */
String getAssetDbtEnvironmentName();
/** TBC */
Long getAssetDbtJobLastRun();
/** TBC */
String getAssetDbtJobLastRunArtifactS3Path();
/** TBC */
Boolean getAssetDbtJobLastRunArtifactsSaved();
/** TBC */
Long getAssetDbtJobLastRunCreatedAt();
/** TBC */
Long getAssetDbtJobLastRunDequedAt();
/** TBC */
String getAssetDbtJobLastRunExecutedByThreadId();
/** TBC */
String getAssetDbtJobLastRunGitBranch();
/** TBC */
String getAssetDbtJobLastRunGitSha();
/** TBC */
Boolean getAssetDbtJobLastRunHasDocsGenerated();
/** TBC */
Boolean getAssetDbtJobLastRunHasSourcesGenerated();
/** TBC */
Boolean getAssetDbtJobLastRunNotificationsSent();
/** TBC */
String getAssetDbtJobLastRunOwnerThreadId();
/** TBC */
String getAssetDbtJobLastRunQueuedDuration();
/** TBC */
String getAssetDbtJobLastRunQueuedDurationHumanized();
/** TBC */
String getAssetDbtJobLastRunRunDuration();
/** TBC */
String getAssetDbtJobLastRunRunDurationHumanized();
/** TBC */
Long getAssetDbtJobLastRunStartedAt();
/** TBC */
String getAssetDbtJobLastRunStatusMessage();
/** TBC */
String getAssetDbtJobLastRunTotalDuration();
/** TBC */
String getAssetDbtJobLastRunTotalDurationHumanized();
/** TBC */
Long getAssetDbtJobLastRunUpdatedAt();
/** TBC */
String getAssetDbtJobLastRunUrl();
/** TBC */
String getAssetDbtJobName();
/** TBC */
Long getAssetDbtJobNextRun();
/** TBC */
String getAssetDbtJobNextRunHumanized();
/** TBC */
String getAssetDbtJobSchedule();
/** TBC */
String getAssetDbtJobScheduleCronHumanized();
/** TBC */
String getAssetDbtJobStatus();
/** TBC */
String getAssetDbtMeta();
/** TBC */
String getAssetDbtPackageName();
/** TBC */
String getAssetDbtProjectName();
/** TBC */
String getAssetDbtSemanticLayerProxyUrl();
/** TBC */
String getAssetDbtSourceFreshnessCriteria();
/** TBC */
SortedSet getAssetDbtTags();
/** TBC */
String getAssetDbtUniqueId();
/** TBC */
SortedSet getAssetMcIncidentNames();
/** TBC */
SortedSet getAssetMcIncidentQualifiedNames();
/** TBC */
SortedSet getAssetMcIncidentSeverities();
/** TBC */
SortedSet getAssetMcIncidentStates();
/** TBC */
SortedSet getAssetMcIncidentSubTypes();
/** TBC */
SortedSet getAssetMcIncidentTypes();
/** TBC */
Long getAssetMcLastSyncRunAt();
/** TBC */
SortedSet getAssetMcMonitorNames();
/** TBC */
SortedSet getAssetMcMonitorQualifiedNames();
/** TBC */
SortedSet getAssetMcMonitorScheduleTypes();
/** TBC */
SortedSet getAssetMcMonitorStatuses();
/** TBC */
SortedSet getAssetMcMonitorTypes();
/** TBC */
SortedSet getAssetTags();
/** TBC */
SortedSet getAssignedTerms();
/** TBC */
CertificateStatus getCertificateStatus();
/** TBC */
String getCertificateStatusMessage();
/** TBC */
Long getCertificateUpdatedAt();
/** TBC */
String getCertificateUpdatedBy();
/** TBC */
String getConnectionName();
/** TBC */
String getConnectionQualifiedName();
/** TBC */
AtlanConnectorType getConnectorType();
/** TBC */
ITableauDatasource getDatasource();
/** TBC */
String getDatasourceQualifiedName();
/** TBC */
String getDbtQualifiedName();
/** TBC */
String getDescription();
/** TBC */
String getDisplayName();
/** TBC */
SortedSet getFiles();
/** TBC */
Boolean getHasLineage();
/** TBC */
SortedSet getInputToProcesses();
/** TBC */
Boolean getIsDiscoverable();
/** TBC */
Boolean getIsEditable();
/** TBC */
Long getLastRowChangedAt();
/** TBC */
String getLastSyncRun();
/** TBC */
Long getLastSyncRunAt();
/** TBC */
String getLastSyncWorkflowName();
/** TBC */
SortedSet getLinks();
/** TBC */
SortedSet getMcIncidents();
/** TBC */
SortedSet getMcMonitors();
/** TBC */
SortedSet getMetrics();
/** TBC */
String getName();
/** TBC */
SortedSet getOutputFromProcesses();
/** TBC */
SortedSet getOwnerGroups();
/** TBC */
SortedSet getOwnerUsers();
/** TBC */
Double getPopularityScore();
/** TBC */
List> getProjectHierarchy();
/** TBC */
String getProjectQualifiedName();
/** TBC */
String getQualifiedName();
/** TBC */
IReadme getReadme();
/** TBC */
String getSampleDataUrl();
/** TBC */
String getSiteQualifiedName();
/** TBC */
SourceCostUnitType getSourceCostUnit();
/** TBC */
Long getSourceCreatedAt();
/** TBC */
String getSourceCreatedBy();
/** TBC */
String getSourceEmbedURL();
/** TBC */
Long getSourceLastReadAt();
/** TBC */
String getSourceOwners();
/** TBC */
List getSourceQueryComputeCostRecords();
/** TBC */
SortedSet getSourceQueryComputeCosts();
/** TBC */
Long getSourceReadCount();
/** TBC */
List getSourceReadExpensiveQueryRecords();
/** TBC */
List getSourceReadPopularQueryRecords();
/** TBC */
Double getSourceReadQueryCost();
/** TBC */
List getSourceReadRecentUserRecords();
/** TBC */
SortedSet getSourceReadRecentUsers();
/** TBC */
List getSourceReadSlowQueryRecords();
/** TBC */
List getSourceReadTopUserRecords();
/** TBC */
SortedSet getSourceReadTopUsers();
/** TBC */
Long getSourceReadUserCount();
/** TBC */
Double getSourceTotalCost();
/** TBC */
String getSourceURL();
/** TBC */
Long getSourceUpdatedAt();
/** TBC */
String getSourceUpdatedBy();
/** TBC */
SortedSet getStarredBy();
/** TBC */
String getSubType();
/** TBC */
String getTenantId();
/** TBC */
String getTopLevelProjectQualifiedName();
/** TBC */
List> getUpstreamFields();
/** TBC */
String getUserDescription();
/** TBC */
Double getViewScore();
/** TBC */
SortedSet getViewerGroups();
/** TBC */
SortedSet getViewerUsers();
/** TBC */
String getWorkbookQualifiedName();
/** TBC */
SortedSet getWorksheets();
/** Name of the type that defines the asset. */
String getTypeName();
/** Globally-unique identifier for the asset. */
String getGuid();
/** Human-readable name of the asset. */
String getDisplayText();
/** Status of the asset (if this is a related asset). */
String getEntityStatus();
/** Type of the relationship (if this is a related asset). */
String getRelationshipType();
/** Unique identifier of the relationship (when this is a related asset). */
String getRelationshipGuid();
/** Status of the relationship (when this is a related asset). */
AtlanStatus getRelationshipStatus();
/** Attributes specific to the relationship (unused). */
RelationshipAttributes getRelationshipAttributes();
/**
* Attribute(s) that uniquely identify the asset (when this is a related asset).
* If the guid is not provided, these must be provided.
*/
UniqueAttributes getUniqueAttributes();
/**
* When true, indicates that this object represents a complete view of the entity.
* When false, this object is only a reference or some partial view of the entity.
*/
boolean isComplete();
/**
* Indicates whether this object can be used as a valid reference by GUID.
* @return true if it is a valid GUID reference, false otherwise
*/
boolean isValidReferenceByGuid();
/**
* Indicates whether this object can be used as a valid reference by qualifiedName.
* @return true if it is a valid qualifiedName reference, false otherwise
*/
boolean isValidReferenceByQualifiedName();
}