com.atlan.model.assets.KafkaField

All Implemented Interfaces:: IAsset, ICatalog, IEventStore, IKafka, IKafkaField, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class KafkaField extends Asset implements IKafkaField, IKafka, IEventStore, ICatalog, IAsset, IReferenceable

Instance of a field within a Kafka topic schema in Atlan, enabling field-level lineage.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

KafkaField.KafkaFieldBuilder<C extends KafkaField,B extends KafkaField.KafkaFieldBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset
Asset.AssetBuilder<C extends Asset,B extends Asset.AssetBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference
Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>, Reference.SaveSemantic

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject
AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>
Field Summary

Fields

Modifier and Type

Field

Description

static final String

TYPE_NAME

Fields inherited from class com.atlan.model.core.AtlanObject
rawJsonObject

Fields inherited from interface com.atlan.model.assets.IAsset
ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, ASSET_AI_GENERATED_DESCRIPTION, ASSET_AI_GENERATED_DESCRIPTION_CONFIDENCE, ASSET_AI_GENERATED_DESCRIPTION_REASONING, ASSET_ANNOUNCEMENT_EXPIRED_AT, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_DQ_FRESHNESS_EXPECTATION, ASSET_DQ_FRESHNESS_VALUE, ASSET_DQ_MANUAL_RUN_STATUS, ASSET_DQ_RESULT, ASSET_DQ_ROW_SCOPE_FILTER_COLUMN_QUALIFIED_NAME, ASSET_DQ_RULE_ATTACHED_DIMENSIONS, ASSET_DQ_RULE_ATTACHED_RULE_TYPES, ASSET_DQ_RULE_FAILED_COUNT, ASSET_DQ_RULE_FAILED_DIMENSIONS, ASSET_DQ_RULE_FAILED_RULE_TYPES, ASSET_DQ_RULE_LAST_RUN_AT, ASSET_DQ_RULE_PASSED_COUNT, ASSET_DQ_RULE_PASSED_DIMENSIONS, ASSET_DQ_RULE_PASSED_RULE_TYPES, ASSET_DQ_RULE_RESULT_TAGS, ASSET_DQ_RULE_TOTAL_COUNT, ASSET_DQ_SCHEDULE_CRONTAB, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_CODE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_MESSAGE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_RAW_ERROR, ASSET_DQ_SCHEDULE_SOURCE_SYNC_STATUS, ASSET_DQ_SCHEDULE_SOURCE_SYNCED_AT, ASSET_DQ_SCHEDULE_TIME_ZONE, ASSET_DQ_SCHEDULE_TYPE, ASSET_EXTERNAL_DQ_METADATA_DETAILS, ASSET_GCP_DATAPLEX_ASPECT_FIELD_LIST, ASSET_GCP_DATAPLEX_ASPECT_LIST, ASSET_GCP_DATAPLEX_METADATA_DETAILS, ASSET_ICON, ASSET_IMMUTA_REQUEST_TYPE, ASSET_IMMUTA_REQUEST_URL, ASSET_INTERNAL_POPULARITY_SCORE, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_IS_MONITORED, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_REDIRECT_GUIDS, ASSET_SMUS_METADATA_FORM_DETAILS, ASSET_SMUS_METADATA_FORM_KEY_VALUE_DETAILS, ASSET_SMUS_METADATA_FORM_NAMES, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_SOURCE_ID, ASSET_SOURCE_README, ASSET_SPACE_NAME, ASSET_SPACE_QUALIFIED_NAME, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, DQ_BASE_DATASET_RULES, DQ_REFERENCE_DATASET_RULES, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERS

Fields inherited from interface com.atlan.model.assets.ICatalog
INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ATTRIBUTES, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS, PARTIAL_CHILD_FIELDS, PARTIAL_CHILD_OBJECTS

Fields inherited from interface com.atlan.model.assets.IKafkaField
KAFKA_FIELD_DATA_TYPE, KAFKA_FIELD_DEFAULT_VALUE, KAFKA_FIELD_IS_OPTIONAL, KAFKA_FIELD_ORDER, KAFKA_FIELD_SCHEMA_TYPE, KAFKA_FIELD_VERSION_INTRODUCED, KAFKA_TOPIC, KAFKA_TOPIC_QUALIFIED_NAME

Fields inherited from interface com.atlan.model.assets.IReferenceable
ASSIGNED_TERMS, ATLAN_TAGS, CREATE_TIME, CREATED_BY, CUSTOM_ATTRIBUTES, GUID, PROPAGATED_ATLAN_TAGS, STATUS, SUPER_TYPE_NAMES, UPDATE_TIME, UPDATED_BY
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

KafkaField(KafkaField.KafkaFieldBuilder<?,?> b)
Method Summary

Modifier and Type

Method

Description

static KafkaField.KafkaFieldBuilder<?,?>

_internal()

static KafkaField

appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)

Deprecated.
see Asset.AssetBuilder.appendAtlanTags(List)

static KafkaField

appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)

Deprecated.
see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)

static KafkaField

appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)

Deprecated.
see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)

protected boolean

canEqual(Object other)

boolean

equals(Object o)

static KafkaField

get(AtlanClient client, String id)

Retrieves a KafkaField by one of its identifiers, complete with all of its relationships.

static KafkaField

get(AtlanClient client, String id, boolean includeAllRelationships)

Retrieves a KafkaField by one of its identifiers, optionally complete with all of its relationships.

static KafkaField

get(AtlanClient client, String id, Collection<AtlanField> attributes)

Retrieves a KafkaField by one of its identifiers, with only the requested attributes (and relationships).

static KafkaField

get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)

Retrieves a KafkaField by one of its identifiers, with only the requested attributes (and relationships).

SortedSet<IAirflowTask>

getInputToAirflowTasks()

Tasks to which this asset provides input.

SortedSet<ILineageProcess>

getInputToProcesses()

Processes to which this asset provides input.

SortedSet<ISparkJob>

getInputToSparkJobs()

TBC

String

getKafkaFieldDataType()

Data type of this field as defined in the schema, for example: string, int, record.

String

getKafkaFieldDefaultValue()

Default value for this field if one is defined in the schema.

Boolean

getKafkaFieldIsOptional()

Whether this field is optional (true) or required (false) in the schema.

Integer

getKafkaFieldOrder()

Position (0-based) of this field in the schema definition.

String

getKafkaFieldSchemaType()

Type of schema from which this field is derived, for example: key or value.

String

getKafkaFieldVersionIntroduced()

Schema version in which this field was first introduced.

IKafkaTopic

getKafkaTopic()

Kafka topic in which this field is defined.

String

getKafkaTopicQualifiedName()

Unique name of the Kafka topic in which this field exists.

SortedSet<IModelAttribute>

getModelImplementedAttributes()

Attributes implemented by this asset.

SortedSet<IModelEntity>

getModelImplementedEntities()

Entities implemented by this asset.

SortedSet<IAirflowTask>

getOutputFromAirflowTasks()

Tasks from which this asset is output.

SortedSet<ILineageProcess>

getOutputFromProcesses()

Processes from which this asset is produced as output.

SortedSet<ISparkJob>

getOutputFromSparkJobs()

TBC

SortedSet<IPartialField>

getPartialChildFields()

Partial fields contained in the asset.

SortedSet<IPartialObject>

getPartialChildObjects()

Partial objects contained in the asset.

String

getTypeName()

Fixed typeName for KafkaFields.

int

hashCode()

static KafkaField

refByGuid(String guid)

Reference to a KafkaField by GUID.

static KafkaField

refByGuid(String guid, Reference.SaveSemantic semantic)

Reference to a KafkaField by GUID.

static KafkaField

refByQualifiedName(String qualifiedName)

Reference to a KafkaField by qualifiedName.

static KafkaField

refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)

Reference to a KafkaField by qualifiedName.

static KafkaField

removeAnnouncement(AtlanClient client, String qualifiedName, String name)

Remove the announcement from a KafkaField.

static void

removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)

Deprecated.
see Asset.AssetBuilder.removeAtlanTag(String)

static KafkaField

removeCertificate(AtlanClient client, String qualifiedName, String name)

Remove the certificate from a KafkaField.

static KafkaField

removeDescription(AtlanClient client, String qualifiedName, String name)

Remove the system description from a KafkaField.

static KafkaField

removeOwners(AtlanClient client, String qualifiedName, String name)

Remove the owners from a KafkaField.

static KafkaField

removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)

Deprecated.
see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)

static KafkaField

removeUserDescription(AtlanClient client, String qualifiedName, String name)

Remove the user's description from a KafkaField.

static KafkaField

replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)

Replace the terms linked to the KafkaField.

static boolean

restore(AtlanClient client, String qualifiedName)

Restore the archived (soft-deleted) KafkaField to active.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client)

Start a fluent search that will return all KafkaField assets.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client, boolean includeArchived)

Start a fluent search that will return all KafkaField assets.

KafkaField.KafkaFieldBuilder<?,?>

toBuilder()

String

toString()

KafkaField

trimToReference()

Builds the minimal object necessary to create a relationship to a KafkaField, from a potentially more-complete KafkaField object.

KafkaField.KafkaFieldBuilder<?,?>

trimToRequired()

Builds the minimal object necessary to apply an update to a KafkaField, from a potentially more-complete KafkaField object.

static KafkaField

updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message)

Update the announcement on a KafkaField.

static KafkaField

updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)

Update the certificate on a KafkaField.

static KafkaField.KafkaFieldBuilder<?,?>

updater(String qualifiedName, String name)

Builds the minimal object necessary to update a KafkaField.

Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM

Methods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getAddedRelationshipAttributes, getCompleteObject, getCustomAttributes, getDisplayText, getDocId, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getRemovedRelationshipAttributes, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequired

Methods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObject

Methods inherited from interface com.atlan.model.assets.IAsset
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.ICatalog
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IEventStore
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IKafka
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IKafkaField
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IReferenceable
getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime

Field Details
- TYPE_NAME
  
  public static final String TYPE_NAME
  See Also:
  
  Constant Field Values
Constructor Details
- KafkaField
  
  protected KafkaField(KafkaField.KafkaFieldBuilder<?,?> b)
Method Details
- trimToReference
  
  public KafkaField trimToReference() throws InvalidRequestException
  
  Builds the minimal object necessary to create a relationship to a KafkaField, from a potentially more-complete KafkaField object.
  
  Overrides:
  
  trimToReference in class Asset
  
  Returns:
  
  the minimal object necessary to relate to the KafkaField
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for a KafkaField relationship are not found in the initial object
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
  
  Start a fluent search that will return all KafkaField 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) KafkaField assets will be included.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the assets
  
  Returns:
  
  a fluent search that includes all KafkaField assets
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
  
  Start a fluent search that will return all KafkaField 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) KafkaFields will be included
  
  Returns:
  
  a fluent search that includes all KafkaField assets
- refByGuid
  
  public static KafkaField refByGuid(String guid)
  
  Reference to a KafkaField by GUID. Use this to create a relationship to this KafkaField, where the relationship should be replaced.
  
  Parameters:
  
  guid - the GUID of the KafkaField to reference
  
  Returns:
  
  reference to a KafkaField that can be used for defining a relationship to a KafkaField
- refByGuid
  
  public static KafkaField refByGuid(String guid, Reference.SaveSemantic semantic)
  
  Reference to a KafkaField by GUID. Use this to create a relationship to this KafkaField, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  guid - the GUID of the KafkaField to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a KafkaField that can be used for defining a relationship to a KafkaField
- refByQualifiedName
  
  public static KafkaField refByQualifiedName(String qualifiedName)
  
  Reference to a KafkaField by qualifiedName. Use this to create a relationship to this KafkaField, where the relationship should be replaced.
  
  Parameters:
  
  qualifiedName - the qualifiedName of the KafkaField to reference
  
  Returns:
  
  reference to a KafkaField that can be used for defining a relationship to a KafkaField
- refByQualifiedName
  
  public static KafkaField refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
  
  Reference to a KafkaField by qualifiedName. Use this to create a relationship to this KafkaField, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  qualifiedName - the qualifiedName of the KafkaField to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a KafkaField that can be used for defining a relationship to a KafkaField
- get
  
  public static KafkaField get(AtlanClient client, String id) throws AtlanException
  
  Retrieves a KafkaField 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 KafkaField to retrieve, either its GUID or its full qualifiedName
  
  Returns:
  
  the requested full KafkaField, complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the KafkaField does not exist or the provided GUID is not a KafkaField
- get
  
  public static KafkaField get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
  
  Retrieves a KafkaField 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 KafkaField to retrieve, either its GUID or its full qualifiedName
  
  includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
  
  Returns:
  
  the requested full KafkaField, optionally complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the KafkaField does not exist or the provided GUID is not a KafkaField
- get
  
  public static KafkaField get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
  
  Retrieves a KafkaField by one of its identifiers, with only the requested attributes (and relationships).
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the asset
  
  id - of the KafkaField to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the KafkaField, including any relationships
  
  Returns:
  
  the requested KafkaField, with only its minimal information and the requested attributes (and relationships)
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the KafkaField does not exist or the provided GUID is not a KafkaField
- get
  
  public static KafkaField get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
  
  Retrieves a KafkaField by one of its identifiers, with only the requested attributes (and relationships).
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the asset
  
  id - of the KafkaField to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the KafkaField, including any relationships
  
  attributesOnRelated - to retrieve on each relationship retrieved for the KafkaField
  
  Returns:
  
  the requested KafkaField, with only its minimal information and the requested attributes (and relationships)
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the KafkaField does not exist or the provided GUID is not a KafkaField
- restore
  
  public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
  
  Restore the archived (soft-deleted) KafkaField to active.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to restore the asset
  
  qualifiedName - for the KafkaField
  
  Returns:
  
  true if the KafkaField is now active, and false otherwise
  
  Throws:
  
  AtlanException - on any API problems
- updater
  
  public static KafkaField.KafkaFieldBuilder<?,?> updater(String qualifiedName, String name)
  
  Builds the minimal object necessary to update a KafkaField.
  
  Parameters:
  
  qualifiedName - of the KafkaField
  
  name - of the KafkaField
  
  Returns:
  
  the minimal request necessary to update the KafkaField, as a builder
- trimToRequired
  
  public KafkaField.KafkaFieldBuilder<?,?> trimToRequired() throws InvalidRequestException
  
  Builds the minimal object necessary to apply an update to a KafkaField, from a potentially more-complete KafkaField object.
  
  Overrides:
  
  trimToRequired in class Asset
  
  Returns:
  
  the minimal object necessary to update the KafkaField, as a builder
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required fields for a KafkaField are not present in the initial object
- removeDescription
  
  public static KafkaField removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the system description from a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the KafkaField
  
  name - of the KafkaField
  
  Returns:
  
  the updated KafkaField, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeUserDescription
  
  public static KafkaField removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the user's description from a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the KafkaField
  
  name - of the KafkaField
  
  Returns:
  
  the updated KafkaField, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeOwners
  
  public static KafkaField removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the owners from a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the KafkaField's owners
  
  qualifiedName - of the KafkaField
  
  name - of the KafkaField
  
  Returns:
  
  the updated KafkaField, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateCertificate
  
  public static KafkaField updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
  
  Update the certificate on a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the KafkaField's certificate
  
  qualifiedName - of the KafkaField
  
  certificate - to use
  
  message - (optional) message, or null if no message
  
  Returns:
  
  the updated KafkaField, or null if the update failed
  
  Throws:
  
  AtlanException - on any API problems
- removeCertificate
  
  public static KafkaField removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the certificate from a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the KafkaField's certificate
  
  qualifiedName - of the KafkaField
  
  name - of the KafkaField
  
  Returns:
  
  the updated KafkaField, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateAnnouncement
  
  public static KafkaField updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
  
  Update the announcement on a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the KafkaField's announcement
  
  qualifiedName - of the KafkaField
  
  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 KafkaField removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the announcement from a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan client from which to remove the KafkaField's announcement
  
  qualifiedName - of the KafkaField
  
  name - of the KafkaField
  
  Returns:
  
  the updated KafkaField, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- replaceTerms
  
  public static KafkaField replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
  
  Replace the terms linked to the KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to replace the KafkaField's assigned terms
  
  qualifiedName - for the KafkaField
  
  name - human-readable name of the KafkaField
  
  terms - the list of terms to replace on the KafkaField, or null to remove all terms from the KafkaField
  
  Returns:
  
  the KafkaField that was updated (note that it will NOT contain details of the replaced terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendTerms
  
  @Deprecated public static KafkaField appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
  
  Link additional terms to the KafkaField, without replacing existing terms linked to the KafkaField. Note: this operation must make two API calls — one to retrieve the KafkaField'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 KafkaField
  
  qualifiedName - for the KafkaField
  
  terms - the list of terms to append to the KafkaField
  
  Returns:
  
  the KafkaField that was updated (note that it will NOT contain details of the appended terms)
  
  Throws:
  
  AtlanException - on any API problems
- removeTerms
  
  @Deprecated public static KafkaField removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
  
  Remove terms from a KafkaField, without replacing all existing terms linked to the KafkaField. Note: this operation must make two API calls — one to retrieve the KafkaField'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 KafkaField
  
  qualifiedName - for the KafkaField
  
  terms - the list of terms to remove from the KafkaField, which must be referenced by GUID
  
  Returns:
  
  the KafkaField that was updated (note that it will NOT contain details of the resulting terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static KafkaField appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAtlanTags(List)
  
  Add Atlan tags to a KafkaField, without replacing existing Atlan tags linked to the KafkaField. Note: this operation must make two API calls — one to retrieve the KafkaField'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 KafkaField
  
  qualifiedName - of the KafkaField
  
  atlanTagNames - human-readable names of the Atlan tags to add
  
  Returns:
  
  the updated KafkaField
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static KafkaField appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)
  
  Add Atlan tags to a KafkaField, without replacing existing Atlan tags linked to the KafkaField. Note: this operation must make two API calls — one to retrieve the KafkaField'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 KafkaField
  
  qualifiedName - of the KafkaField
  
  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 KafkaField
  
  Throws:
  
  AtlanException - on any API problems
- removeAtlanTag
  
  @Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.removeAtlanTag(String)
  
  Remove an Atlan tag from a KafkaField.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove an Atlan tag from a KafkaField
  
  qualifiedName - of the KafkaField
  
  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 KafkaField
- _internal
  
  public static KafkaField.KafkaFieldBuilder<?,?> _internal()
- toBuilder
  
  public KafkaField.KafkaFieldBuilder<?,?> toBuilder()
  
  Overrides:
  
  toBuilder in class Reference
- getInputToAirflowTasks
  
  public SortedSet<IAirflowTask> getInputToAirflowTasks()
  
  Tasks to which this asset provides input.
  
  Specified by:
  
  getInputToAirflowTasks in interface ICatalog
  
  Specified by:
  
  getInputToAirflowTasks in interface IEventStore
  
  Specified by:
  
  getInputToAirflowTasks in interface IKafka
  
  Specified by:
  
  getInputToAirflowTasks in interface IKafkaField
- getInputToProcesses
  
  public SortedSet<ILineageProcess> getInputToProcesses()
  
  Processes to which this asset provides input.
  
  Specified by:
  
  getInputToProcesses in interface ICatalog
  
  Specified by:
  
  getInputToProcesses in interface IEventStore
  
  Specified by:
  
  getInputToProcesses in interface IKafka
  
  Specified by:
  
  getInputToProcesses in interface IKafkaField
- getInputToSparkJobs
  
  public SortedSet<ISparkJob> getInputToSparkJobs()
  
  TBC
  
  Specified by:
  
  getInputToSparkJobs in interface ICatalog
  
  Specified by:
  
  getInputToSparkJobs in interface IEventStore
  
  Specified by:
  
  getInputToSparkJobs in interface IKafka
  
  Specified by:
  
  getInputToSparkJobs in interface IKafkaField
- getKafkaFieldDataType
  
  public String getKafkaFieldDataType()
  
  Data type of this field as defined in the schema, for example: string, int, record.
  
  Specified by:
  
  getKafkaFieldDataType in interface IKafkaField
- getKafkaFieldDefaultValue
  
  public String getKafkaFieldDefaultValue()
  
  Default value for this field if one is defined in the schema.
  
  Specified by:
  
  getKafkaFieldDefaultValue in interface IKafkaField
- getKafkaFieldIsOptional
  
  public Boolean getKafkaFieldIsOptional()
  
  Whether this field is optional (true) or required (false) in the schema.
  
  Specified by:
  
  getKafkaFieldIsOptional in interface IKafkaField
- getKafkaFieldOrder
  
  public Integer getKafkaFieldOrder()
  
  Position (0-based) of this field in the schema definition.
  
  Specified by:
  
  getKafkaFieldOrder in interface IKafkaField
- getKafkaFieldSchemaType
  
  public String getKafkaFieldSchemaType()
  
  Type of schema from which this field is derived, for example: key or value.
  
  Specified by:
  
  getKafkaFieldSchemaType in interface IKafkaField
- getKafkaFieldVersionIntroduced
  
  public String getKafkaFieldVersionIntroduced()
  
  Schema version in which this field was first introduced.
  
  Specified by:
  
  getKafkaFieldVersionIntroduced in interface IKafkaField
- getKafkaTopic
  
  public IKafkaTopic getKafkaTopic()
  
  Kafka topic in which this field is defined.
  
  Specified by:
  
  getKafkaTopic in interface IKafkaField
- getKafkaTopicQualifiedName
  
  public String getKafkaTopicQualifiedName()
  
  Unique name of the Kafka topic in which this field exists.
  
  Specified by:
  
  getKafkaTopicQualifiedName in interface IKafkaField
- getModelImplementedAttributes
  
  public SortedSet<IModelAttribute> getModelImplementedAttributes()
  
  Attributes implemented by this asset.
  
  Specified by:
  
  getModelImplementedAttributes in interface ICatalog
  
  Specified by:
  
  getModelImplementedAttributes in interface IEventStore
  
  Specified by:
  
  getModelImplementedAttributes in interface IKafka
  
  Specified by:
  
  getModelImplementedAttributes in interface IKafkaField
- getModelImplementedEntities
  
  public SortedSet<IModelEntity> getModelImplementedEntities()
  
  Entities implemented by this asset.
  
  Specified by:
  
  getModelImplementedEntities in interface ICatalog
  
  Specified by:
  
  getModelImplementedEntities in interface IEventStore
  
  Specified by:
  
  getModelImplementedEntities in interface IKafka
  
  Specified by:
  
  getModelImplementedEntities in interface IKafkaField
- getOutputFromAirflowTasks
  
  public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
  
  Tasks from which this asset is output.
  
  Specified by:
  
  getOutputFromAirflowTasks in interface ICatalog
  
  Specified by:
  
  getOutputFromAirflowTasks in interface IEventStore
  
  Specified by:
  
  getOutputFromAirflowTasks in interface IKafka
  
  Specified by:
  
  getOutputFromAirflowTasks in interface IKafkaField
- getOutputFromProcesses
  
  public SortedSet<ILineageProcess> getOutputFromProcesses()
  
  Processes from which this asset is produced as output.
  
  Specified by:
  
  getOutputFromProcesses in interface ICatalog
  
  Specified by:
  
  getOutputFromProcesses in interface IEventStore
  
  Specified by:
  
  getOutputFromProcesses in interface IKafka
  
  Specified by:
  
  getOutputFromProcesses in interface IKafkaField
- getOutputFromSparkJobs
  
  public SortedSet<ISparkJob> getOutputFromSparkJobs()
  
  TBC
  
  Specified by:
  
  getOutputFromSparkJobs in interface ICatalog
  
  Specified by:
  
  getOutputFromSparkJobs in interface IEventStore
  
  Specified by:
  
  getOutputFromSparkJobs in interface IKafka
  
  Specified by:
  
  getOutputFromSparkJobs in interface IKafkaField
- getPartialChildFields
  
  public SortedSet<IPartialField> getPartialChildFields()
  
  Partial fields contained in the asset.
  
  Specified by:
  
  getPartialChildFields in interface ICatalog
  
  Specified by:
  
  getPartialChildFields in interface IEventStore
  
  Specified by:
  
  getPartialChildFields in interface IKafka
  
  Specified by:
  
  getPartialChildFields in interface IKafkaField
- getPartialChildObjects
  
  public SortedSet<IPartialObject> getPartialChildObjects()
  
  Partial objects contained in the asset.
  
  Specified by:
  
  getPartialChildObjects in interface ICatalog
  
  Specified by:
  
  getPartialChildObjects in interface IEventStore
  
  Specified by:
  
  getPartialChildObjects in interface IKafka
  
  Specified by:
  
  getPartialChildObjects in interface IKafkaField
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Asset
- canEqual
  
  protected boolean canEqual(Object other)
  
  Overrides:
  
  canEqual in class Asset
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Asset
- toString
  
  public String toString()
  
  Description copied from class: AtlanObject
  
  Overrides:
  
  toString in class Asset
- getTypeName
  
  public String getTypeName()
  
  Fixed typeName for KafkaFields.
  
  Specified by:
  
  getTypeName in interface AuditDetail
  
  Specified by:
  
  getTypeName in interface IAsset
  
  Specified by:
  
  getTypeName in interface ICatalog
  
  Specified by:
  
  getTypeName in interface IEventStore
  
  Specified by:
  
  getTypeName in interface IKafka
  
  Specified by:
  
  getTypeName in interface IKafkaField
  
  Specified by:
  
  getTypeName in interface IReferenceable
  
  Overrides:
  
  getTypeName in class Reference

Class KafkaField

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

Fields inherited from interface com.atlan.model.assets.IAsset

Fields inherited from interface com.atlan.model.assets.ICatalog

Fields inherited from interface com.atlan.model.assets.IKafkaField

Fields inherited from interface com.atlan.model.assets.IReferenceable

Constructor Summary

Method Summary

Methods inherited from class com.atlan.model.assets.Asset

Methods inherited from class com.atlan.model.relations.Reference

Methods inherited from class com.atlan.model.core.AtlanObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlan.model.search.AuditDetail

Methods inherited from interface com.atlan.model.assets.IAsset

Methods inherited from interface com.atlan.model.assets.ICatalog

Methods inherited from interface com.atlan.model.assets.IEventStore

Methods inherited from interface com.atlan.model.assets.IKafka

Methods inherited from interface com.atlan.model.assets.IKafkaField

Methods inherited from interface com.atlan.model.assets.IReferenceable

Field Details

TYPE_NAME

Constructor Details

KafkaField

Method Details

trimToReference

select

select

refByGuid

refByGuid

refByQualifiedName

refByQualifiedName

get

get

get

get

restore

updater

trimToRequired

removeDescription

removeUserDescription

removeOwners

updateCertificate

removeCertificate

updateAnnouncement

removeAnnouncement

replaceTerms

appendTerms

removeTerms

appendAtlanTags

appendAtlanTags

removeAtlanTag

_internal

toBuilder

getInputToAirflowTasks

getInputToProcesses

getInputToSparkJobs

getKafkaFieldDataType

getKafkaFieldDefaultValue

getKafkaFieldIsOptional

getKafkaFieldOrder

getKafkaFieldSchemaType

getKafkaFieldVersionIntroduced

getKafkaTopic

getKafkaTopicQualifiedName

getModelImplementedAttributes

getModelImplementedEntities

getOutputFromAirflowTasks

getOutputFromProcesses

getOutputFromSparkJobs

getPartialChildFields

getPartialChildObjects

equals

canEqual

hashCode

toString