Package com.atlan.model.assets
Class APIQuery.APIQueryBuilder<C extends APIQuery,B extends APIQuery.APIQueryBuilder<C,B>>
java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.relations.Reference.ReferenceBuilder<C,B>
com.atlan.model.assets.Asset.AssetBuilder<C,B>
com.atlan.model.assets.APIQuery.APIQueryBuilder<C,B>
- Enclosing class:
- APIQuery
public abstract static class APIQuery.APIQueryBuilder<C extends APIQuery,B extends APIQuery.APIQueryBuilder<C,B>>
extends Asset.AssetBuilder<C,B>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected B
$fillValuesFrom
(C instance) apiExternalDoc
(String apiExternalDocKey, String apiExternalDocValue) apiExternalDocs
(Map<? extends String, ? extends String> apiExternalDocs) apiFields
(Collection<? extends IAPIField> apiFields) apiInputFieldCount
(Long apiInputFieldCount) Count of the APIField of this query that are input to it.apiIsAuthOptional
(Boolean apiIsAuthOptional) Whether authentication is optional (true) or required (false).apiIsObjectReference
(Boolean apiIsObjectReference) If this asset refers to an APIObjectapiObjectQualifiedName
(String apiObjectQualifiedName) Qualified name of the APIObject that is referred to by this asset.apiQueryOutputType
(String apiQueryOutputType) Type of APIQueryOutput.apiQueryOutputTypeSecondary
(String apiQueryOutputTypeSecondary) Secondary Type of APIQueryOutput.apiSpecName
(String apiSpecName) Simple name of the API spec, if this asset is contained in an API spec.apiSpecQualifiedName
(String apiSpecQualifiedName) Unique name of the API spec, if this asset is contained in an API spec.apiSpecType
(String apiSpecType) Type of API, for example: OpenAPI, GraphQL, etc.apiSpecVersion
(String apiSpecVersion) Version of the API specification.applicationContainer
(IApplicationContainer applicationContainer) ApplicationContainer asset containing this Catalog asset.assetApplicationQualifiedName
(String assetApplicationQualifiedName) Qualified name of the Application Container that contains this asset.abstract C
build()
inputToAirflowTask
(IAirflowTask inputToAirflowTask) inputToAirflowTasks
(Collection<? extends IAirflowTask> inputToAirflowTasks) inputToProcess
(ILineageProcess inputToProcess) inputToProcesses
(Collection<? extends ILineageProcess> inputToProcesses) inputToSparkJob
(ISparkJob inputToSparkJob) inputToSparkJobs
(Collection<? extends ISparkJob> inputToSparkJobs) modelImplementedEntities
(Collection<? extends IModelEntity> modelImplementedEntities) modelImplementedEntity
(IModelEntity modelImplementedEntity) outputFromAirflowTask
(IAirflowTask outputFromAirflowTask) outputFromAirflowTasks
(Collection<? extends IAirflowTask> outputFromAirflowTasks) outputFromProcess
(ILineageProcess outputFromProcess) outputFromProcesses
(Collection<? extends ILineageProcess> outputFromProcesses) outputFromSparkJob
(ISparkJob outputFromSparkJob) outputFromSparkJobs
(Collection<? extends ISparkJob> outputFromSparkJobs) protected abstract B
self()
toString()
Fixed typeName for APIQuerys.Methods inherited from class com.atlan.model.assets.Asset.AssetBuilder
addStarredBy, adminGroup, adminGroups, adminRole, adminRoles, adminUser, adminUsers, announcementMessage, announcementTitle, announcementType, announcementUpdatedAt, announcementUpdatedBy, anomaloCheck, anomaloChecks, assetAnomaloAppliedCheckType, assetAnomaloAppliedCheckTypes, assetAnomaloCheckCount, assetAnomaloCheckStatuses, assetAnomaloDQStatus, assetAnomaloFailedCheckCount, assetAnomaloFailedCheckType, assetAnomaloFailedCheckTypes, assetAnomaloLastCheckRunAt, assetAnomaloSourceUrl, assetCoverImage, assetDbtAccountName, assetDbtAlias, assetDbtEnvironmentDbtVersion, assetDbtEnvironmentName, assetDbtJobLastRun, assetDbtJobLastRunArtifactS3Path, assetDbtJobLastRunArtifactsSaved, assetDbtJobLastRunCreatedAt, assetDbtJobLastRunDequedAt, assetDbtJobLastRunExecutedByThreadId, assetDbtJobLastRunGitBranch, assetDbtJobLastRunGitSha, assetDbtJobLastRunHasDocsGenerated, assetDbtJobLastRunHasSourcesGenerated, assetDbtJobLastRunNotificationsSent, assetDbtJobLastRunOwnerThreadId, assetDbtJobLastRunQueuedDuration, assetDbtJobLastRunQueuedDurationHumanized, assetDbtJobLastRunRunDuration, assetDbtJobLastRunRunDurationHumanized, assetDbtJobLastRunStartedAt, assetDbtJobLastRunStatusMessage, assetDbtJobLastRunTotalDuration, assetDbtJobLastRunTotalDurationHumanized, assetDbtJobLastRunUpdatedAt, assetDbtJobLastRunUrl, assetDbtJobName, assetDbtJobNextRun, assetDbtJobNextRunHumanized, assetDbtJobSchedule, assetDbtJobScheduleCronHumanized, assetDbtJobStatus, assetDbtMeta, assetDbtPackageName, assetDbtProjectName, assetDbtSemanticLayerProxyUrl, assetDbtSourceFreshnessCriteria, assetDbtTag, assetDbtTags, assetDbtTestStatus, assetDbtUniqueId, assetDbtWorkflowLastUpdated, assetIcon, assetMcAlertQualifiedName, assetMcAlertQualifiedNames, assetMcIncidentName, assetMcIncidentNames, assetMcIncidentPriorities, assetMcIncidentPriority, assetMcIncidentQualifiedName, assetMcIncidentQualifiedNames, assetMcIncidentSeverities, assetMcIncidentSeverity, assetMcIncidentState, assetMcIncidentStates, assetMcIncidentSubType, assetMcIncidentSubTypes, assetMcIncidentType, assetMcIncidentTypes, assetMcLastSyncRunAt, assetMcMonitorName, assetMcMonitorNames, assetMcMonitorQualifiedName, assetMcMonitorQualifiedNames, assetMcMonitorScheduleType, assetMcMonitorScheduleTypes, assetMcMonitorStatus, assetMcMonitorStatuses, assetMcMonitorType, assetMcMonitorTypes, assetPoliciesCount, assetPolicyGUID, assetPolicyGUIDs, assetSodaCheckCount, assetSodaCheckStatuses, assetSodaDQStatus, assetSodaLastScanAt, assetSodaLastSyncRunAt, assetSodaSourceURL, assetTag, assetTags, assetThemeHex, assignedTerm, assignedTerms, atlanTag, atlanTagName, atlanTagNames, atlanTags, certificateStatus, certificateStatusMessage, certificateUpdatedAt, certificateUpdatedBy, clearAdminGroups, clearAdminRoles, clearAdminUsers, clearAnomaloChecks, clearAssetAnomaloAppliedCheckTypes, clearAssetAnomaloFailedCheckTypes, clearAssetDbtTags, clearAssetMcAlertQualifiedNames, clearAssetMcIncidentNames, clearAssetMcIncidentPriorities, clearAssetMcIncidentQualifiedNames, clearAssetMcIncidentSeverities, clearAssetMcIncidentStates, clearAssetMcIncidentSubTypes, clearAssetMcIncidentTypes, clearAssetMcMonitorNames, clearAssetMcMonitorQualifiedNames, clearAssetMcMonitorScheduleTypes, clearAssetMcMonitorStatuses, clearAssetMcMonitorTypes, clearAssetPolicyGUIDs, clearAssetTags, clearAssignedTerms, clearAtlanTagNames, clearAtlanTags, clearCustomMetadataSets, clearDomainGUIDs, clearFiles, clearInputPortDataProducts, clearLinks, clearMcIncidents, clearMcMonitors, clearMeaningNames, clearMeanings, clearMetrics, clearNonCompliantAssetPolicyGUIDs, clearNullFields, clearOutputPortDataProducts, clearOwnerGroups, clearOwnerUsers, clearPendingTasks, clearSchemaRegistrySubjects, clearSodaChecks, clearSourceQueryComputeCostRecords, clearSourceQueryComputeCosts, clearSourceReadExpensiveQueryRecords, clearSourceReadPopularQueryRecords, clearSourceReadRecentUserRecords, clearSourceReadRecentUsers, clearSourceReadSlowQueryRecords, clearSourceReadTopUserRecords, clearSourceReadTopUsers, clearStarredBy, clearStarredDetails, clearUserDefRelationshipFroms, clearUserDefRelationshipTos, clearViewerGroups, clearViewerUsers, connectionName, connectionQualifiedName, connectorType, createdBy, createTime, customMetadata, customMetadataSets, dataContractLatest, dataContractLatestCertified, dbtQualifiedName, deleteHandler, depth, description, displayName, domainGUID, domainGUIDs, file, files, hasContract, hasLineage, immediateDownstream, immediateUpstream, inputPortDataProduct, inputPortDataProducts, isAIGenerated, isDiscoverable, isEditable, isIncomplete, isPartial, lastRowChangedAt, lastSyncRun, lastSyncRunAt, lastSyncWorkflowName, lexicographicalSortOrder, link, links, mcIncident, mcIncidents, mcMonitor, mcMonitors, meaning, meaningName, meaningNames, meanings, metric, metrics, name, nonCompliantAssetPolicyGUID, nonCompliantAssetPolicyGUIDs, nullField, nullFields, outputPortDataProduct, outputPortDataProducts, ownerGroup, ownerGroups, ownerUser, ownerUsers, pendingTask, pendingTasks, popularityScore, qualifiedName, readme, removeAnnouncement, removeAssignedTerms, removeAtlanTags, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeUserDescription, sampleDataUrl, schemaRegistrySubject, schemaRegistrySubjects, sodaCheck, sodaChecks, sourceCostUnit, sourceCreatedAt, sourceCreatedBy, sourceEmbedURL, sourceLastReadAt, sourceOwners, sourceQueryComputeCost, sourceQueryComputeCostRecord, sourceQueryComputeCostRecords, sourceQueryComputeCosts, sourceReadCount, sourceReadExpensiveQueryRecord, sourceReadExpensiveQueryRecords, sourceReadPopularQueryRecord, sourceReadPopularQueryRecords, sourceReadQueryCost, sourceReadRecentUser, sourceReadRecentUserRecord, sourceReadRecentUserRecords, sourceReadRecentUsers, sourceReadSlowQueryRecord, sourceReadSlowQueryRecords, sourceReadTopUser, sourceReadTopUserRecord, sourceReadTopUserRecords, sourceReadTopUsers, sourceReadUserCount, sourceTotalCost, sourceUpdatedAt, sourceUpdatedBy, sourceURL, starredBy, starredCount, starredDetail, starredDetails, status, subType, tenantId, updatedBy, updateTime, userDefRelationshipFrom, userDefRelationshipFroms, userDefRelationshipTo, userDefRelationshipTos, userDescription, viewerGroup, viewerGroups, viewerUser, viewerUsers, viewScore
Methods inherited from class com.atlan.model.relations.Reference.ReferenceBuilder
clearCustomAttributes, clearLabels, completeObject, customAttribute, customAttributes, displayText, entityStatus, guid, label, labels, relationshipAttributes, relationshipGuid, relationshipStatus, relationshipType, semantic, uniqueAttributes
Methods inherited from class com.atlan.model.core.AtlanObject.AtlanObjectBuilder
rawJsonObject
-
Constructor Details
-
APIQueryBuilder
public APIQueryBuilder()
-
-
Method Details
-
$fillValuesFrom
- Overrides:
$fillValuesFrom
in classAsset.AssetBuilder<C extends APIQuery,
B extends APIQuery.APIQueryBuilder<C, B>>
-
typeName
Fixed typeName for APIQuerys.- Overrides:
typeName
in classReference.ReferenceBuilder<C extends APIQuery,
B extends APIQuery.APIQueryBuilder<C, B>> - Returns:
this
.
-
apiExternalDoc
-
apiExternalDocs
-
clearApiExternalDocs
-
apiField
-
apiFields
-
clearApiFields
-
apiInputFieldCount
Count of the APIField of this query that are input to it.- Returns:
this
.
-
apiIsAuthOptional
Whether authentication is optional (true) or required (false).- Returns:
this
.
-
apiIsObjectReference
If this asset refers to an APIObject- Returns:
this
.
-
apiObjectQualifiedName
Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.- Returns:
this
.
-
apiQueryOutputType
Type of APIQueryOutput. E.g. STRING, NUMBER etc. It is free text.- Returns:
this
.
-
apiQueryOutputTypeSecondary
Secondary Type of APIQueryOutput. E.g. LIST/STRING then LIST would be the secondary type.- Returns:
this
.
-
apiSpecName
Simple name of the API spec, if this asset is contained in an API spec.- Returns:
this
.
-
apiSpecQualifiedName
Unique name of the API spec, if this asset is contained in an API spec.- Returns:
this
.
-
apiSpecType
Type of API, for example: OpenAPI, GraphQL, etc.- Returns:
this
.
-
apiSpecVersion
Version of the API specification.- Returns:
this
.
-
applicationContainer
ApplicationContainer asset containing this Catalog asset.- Returns:
this
.
-
assetApplicationQualifiedName
Qualified name of the Application Container that contains this asset.- Returns:
this
.
-
inputToAirflowTask
-
inputToAirflowTasks
-
clearInputToAirflowTasks
-
inputToProcess
-
inputToProcesses
-
clearInputToProcesses
-
inputToSparkJob
-
inputToSparkJobs
-
clearInputToSparkJobs
-
modelImplementedEntity
-
modelImplementedEntities
-
clearModelImplementedEntities
-
outputFromAirflowTask
-
outputFromAirflowTasks
-
clearOutputFromAirflowTasks
-
outputFromProcess
-
outputFromProcesses
-
clearOutputFromProcesses
-
outputFromSparkJob
-
outputFromSparkJobs
-
clearOutputFromSparkJobs
-
self
- Specified by:
self
in classAsset.AssetBuilder<C extends APIQuery,
B extends APIQuery.APIQueryBuilder<C, B>>
-
build
- Specified by:
build
in classAsset.AssetBuilder<C extends APIQuery,
B extends APIQuery.APIQueryBuilder<C, B>>
-
toString
- Overrides:
toString
in classAsset.AssetBuilder<C extends APIQuery,
B extends APIQuery.APIQueryBuilder<C, B>>
-