structs

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 27, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ServiceAccount = "SERVICE_ACCOUNT_"
	// The value was previously set to 13 years (409968000 secs).
	// It has been reverted to 5 years due to an integer overflow issue in Keycloak.
	// https://github.com/keycloak/keycloak/issues/19671
	MaxValidity = 157680000 // 5 years in seconds
)

Variables

This section is empty.

Functions

func StringPtr 

func StringPtr(s string) *string

Types

type AccessControl added in v0.0.12 

type AccessControl struct {
	Asset
	IsAccessControlEnabled  *bool         `json:"isAccessControlEnabled,omitempty"`
	DenyCustomMetadataGuids *[]string     `json:"denyCustomMetadataGuids,omitempty"`
	DenyAssetTabs           *[]string     `json:"denyAssetTabs,omitempty"`
	DenyAssetFilters        *[]string     `json:"denyAssetFilters,omitempty"`
	ChannelLink             *string       `json:"channelLink,omitempty"`
	DenyAssetTypes          *[]string     `json:"denyAssetTypes,omitempty"`
	DenyNavigationPages     *[]string     `json:"denyNavigationPages,omitempty"`
	DefaultNavigation       *string       `json:"defaultNavigation,omitempty"`
	DisplayPreferences      *[]string     `json:"displayPreferences,omitempty"`
	Policies                *[]AuthPolicy `json:"policies,omitempty"` // Relationship
	UniqueAttributes        struct {
		QualifiedName *string `json:"qualifiedName,omitempty"`
	} `json:"uniqueAttributes,omitempty"`
}

AccessControl represents the attributes of the AccessControl asset.

type AdminEvent added in v0.0.13 

type AdminEvent struct {
	OperationType  *string      `json:"operationType,omitempty"` // Type of admin operation that occurred.
	RealmID        *string      `json:"realmID,omitempty"`
	Representation *string      `json:"representation,omitempty"`
	ResourcePath   *string      `json:"resourcePath,omitempty"`
	ResourceType   *string      `json:"resourceType,omitempty"` // Type of resource for the admin operation that occurred.
	Time           *int64       `json:"time,omitempty"`         // Time (epoch) when the admin operation occurred, in milliseconds.
	AuthDetails    *AuthDetails `json:"authDetails,omitempty"`
}

AdminEvent represents an admin operation event for an Atlan user.

type AirFlowTask 

type AirFlowTask struct {
	Asset
}

type ApiToken added in v0.0.14 

type ApiToken struct {
	GUID        *string             `json:"id,omitempty"`          // Unique identifier of the API token.
	ClientID    *string             `json:"clientId,omitempty"`    // Unique client identifier of the token.
	DisplayName *string             `json:"displayName,omitempty"` // Human-readable name of the token.
	Attributes  *ApiTokenAttributes `json:"attributes,omitempty"`  // Detailed characteristics of the token.
}

ApiToken represents an API token object.

func (*ApiToken) UnmarshalJSON added in v0.0.14 

func (t *ApiToken) UnmarshalJSON(data []byte) error

UnmarshalJSON for ApiToken to handle attributes.

func (*ApiToken) Username added in v0.0.14 

func (a *ApiToken) Username() string

Username generates a service account username based on the token's client ID.

type ApiTokenAttributes added in v0.0.14 

type ApiTokenAttributes struct {
	AccessTokenLifespan  *string            `json:"access.token.lifespan,omitempty"` // Time in seconds after which the token will expire.
	AccessToken          *string            `json:"accessToken,omitempty"`           // The actual API token.
	ClientID             *string            `json:"clientId,omitempty"`              // Unique client identifier of the API token.
	CreatedAt            *string            `json:"createdAt,omitempty"`             // Epoch time when the token was created.
	CreatedBy            *string            `json:"createdBy,omitempty"`             // User who created the token.
	Description          *string            `json:"description,omitempty"`           // Explanation of the token.
	DisplayName          *string            `json:"displayName,omitempty"`           // Human-readable name of the token.
	Personas             []string           `json:"personas,omitempty"`              // personas associated with the token.
	PersonaQualifiedName []*ApiTokenPersona `json:"personaQualifiedName,omitempty"`  // Associated personas with the token.
	Purposes             interface{}        `json:"purposes,omitempty"`              // Placeholder for purposes associated with the token.
	WorkspacePermissions []string           `json:"workspacePermissions,omitempty"`  // Permissions associated with the token.
}

ApiTokenAttributes contains detailed characteristics of an API token.

func (*ApiTokenAttributes) UnmarshalJSON added in v0.0.14 

func (a *ApiTokenAttributes) UnmarshalJSON(data []byte) error

UnmarshalJSON for ApiTokenAttributes to handle nested fields.

type ApiTokenPersona added in v0.0.14 

type ApiTokenPersona struct {
	GUID                 *string `json:"id,omitempty"`                   // Unique identifier (GUID) of the linked persona.
	Persona              *string `json:"persona,omitempty"`              // Unique name of the linked persona.
	PersonaQualifiedName *string `json:"personaQualifiedName,omitempty"` // Unique qualified name of the persona.
}

ApiTokenPersona represents a linked persona in the API token model.

type ApiTokenRequest added in v0.0.14 

type ApiTokenRequest struct {
	DisplayName           *string  `json:"displayName,omitempty"`           // Human-readable name of the token.
	Description           string   `json:"description,omitempty"`           // Explanation of the token.
	Personas              []string `json:"personas,omitempty"`              // GUIDs of associated personas.
	PersonaQualifiedNames []string `json:"personaQualifiedNames,omitempty"` // Qualified names of associated personas.
	ValiditySeconds       *int     `json:"validitySeconds,omitempty"`       // Validity of the token in seconds.
}

ApiTokenRequest represents the request body for creating or updating an API token.

func (*ApiTokenRequest) SetMaxValidity added in v0.0.14 

func (r *ApiTokenRequest) SetMaxValidity()

SetMaxValidity ensures validity seconds are within allowed range.

type Asset 

type Asset struct {
	Referenceable
	// List of groups who administer this asset.
	AdminGroups *[]string `json:"adminGroups,omitempty"`
	// List of roles who administer this asset.
	AdminRoles *[]string `json:"adminRoles,omitempty"`
	// List of users who administer this asset.
	AdminUsers *[]string `json:"adminUsers,omitempty"`
	// Detailed message to include in the announcement on this asset.
	AnnouncementMessage *string `json:"announcementMessage,omitempty"`
	// Brief title for the announcement on this asset.
	AnnouncementTitle *string `json:"announcementTitle,omitempty"`
	// Type of announcement on this asset.
	AnnouncementType *atlan.AnnouncementType `json:"announcementType,omitempty"`
	// Time (epoch) at which the announcement was last updated, in milliseconds.
	AnnouncementUpdatedAt *int64 `json:"announcementUpdatedAt,omitempty"`
	// Name of the user who last updated the announcement.
	AnnouncementUpdatedBy *string `json:"announcementUpdatedBy,omitempty"`
	// Name of the account in which this asset exists in dbt.
	AssetDbtAccountName *string `json:"assetDbtAccountName,omitempty"`
	// Alias of this asset in dbt.
	AssetDbtAlias *string `json:"assetDbtAlias,omitempty"`
	// Version of the environment in which this asset is materialized in dbt.
	AssetDbtEnvironmentDbtVersion *string `json:"assetDbtEnvironmentDbtVersion,omitempty"`
	// Name of the environment in which this asset is materialized in dbt.
	AssetDbtEnvironmentName *string `json:"assetDbtEnvironmentName,omitempty"`
	// Time (epoch) at which the job that materialized this asset in dbt last ran, in milliseconds.
	AssetDbtJobLastRun *int64 `json:"assetDbtJobLastRun,omitempty"`
	// Path in S3 to the artifacts saved from the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunArtifactS3Path *string `json:"assetDbtJobLastRunArtifactS3Path,omitempty"`
	// Whether artifacts were saved from the last run of the job that materialized this asset in dbt (true) or not (false).
	AssetDbtJobLastRunArtifactsSaved *bool `json:"assetDbtJobLastRunArtifactsSaved,omitempty"`
	// Time (epoch) at which the job that materialized this asset in dbt was last created, in milliseconds.
	AssetDbtJobLastRunCreatedAt *int64 `json:"assetDbtJobLastRunCreatedAt,omitempty"`
	// Time (epoch) at which the job that materialized this asset in dbt was dequeued, in milliseconds.
	AssetDbtJobLastRunDequedAt *int64 `json:"assetDbtJobLastRunDequedAt,omitempty"`
	// Thread ID of the user who executed the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunExecutedByThreadId *string `json:"assetDbtJobLastRunExecutedByThreadId,omitempty"`
	// Branch in git from which the last run of the job that materialized this asset in dbt ran.
	AssetDbtJobLastRunGitBranch *string `json:"assetDbtJobLastRunGitBranch,omitempty"`
	// SHA hash in git for the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunGitSha *string `json:"assetDbtJobLastRunGitSha,omitempty"`
	// Whether docs were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
	AssetDbtJobLastRunHasDocsGenerated *bool `json:"assetDbtJobLastRunHasDocsGenerated,omitempty"`
	// Whether sources were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
	AssetDbtJobLastRunHasSourcesGenerated *bool `json:"assetDbtJobLastRunHasSourcesGenerated,omitempty"`
	// Whether notifications were sent from the last run of the job that materialized this asset in dbt (true) or not (false).
	AssetDbtJobLastRunNotificationsSent *bool `json:"assetDbtJobLastRunNotificationsSent,omitempty"`
	// Thread ID of the owner of the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunOwnerThreadId *string `json:"assetDbtJobLastRunOwnerThreadId,omitempty"`
	// Total duration the job that materialized this asset in dbt spent being queued.
	AssetDbtJobLastRunQueuedDuration *string `json:"assetDbtJobLastRunQueuedDuration,omitempty"`
	// Human-readable total duration of the last run of the job that materialized this asset in dbt spend being queued.
	AssetDbtJobLastRunQueuedDurationHumanized *string `json:"assetDbtJobLastRunQueuedDurationHumanized,omitempty"`
	// Run duration of the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunRunDuration *string `json:"assetDbtJobLastRunRunDuration,omitempty"`
	// Human-readable run duration of the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunRunDurationHumanized *string `json:"assetDbtJobLastRunRunDurationHumanized,omitempty"`
	// Time (epoch) at which the job that materialized this asset in dbt was started running, in milliseconds.
	AssetDbtJobLastRunStartedAt *int64 `json:"assetDbtJobLastRunStartedAt,omitempty"`
	// Status message of the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunStatusMessage *string `json:"assetDbtJobLastRunStatusMessage,omitempty"`
	// Total duration of the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunTotalDuration *string `json:"assetDbtJobLastRunTotalDuration,omitempty"`
	// Human-readable total duration of the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunTotalDurationHumanized *string `json:"assetDbtJobLastRunTotalDurationHumanized,omitempty"`
	// Time (epoch) at which the job that materialized this asset in dbt was last updated, in milliseconds.
	AssetDbtJobLastRunUpdatedAt *int64 `json:"assetDbtJobLastRunUpdatedAt,omitempty"`
	// URL of the last run of the job that materialized this asset in dbt.
	AssetDbtJobLastRunUrl *string `json:"assetDbtJobLastRunUrl,omitempty"`
	// Name of the job that materialized this asset in dbt.
	AssetDbtJobName *string `json:"assetDbtJobName,omitempty"`
	// Time (epoch) when the next run of the job that materializes this asset in dbt is scheduled.
	AssetDbtJobNextRun *int64 `json:"assetDbtJobNextRun,omitempty"`
	// Human-readable time when the next run of the job that materializes this asset in dbt is scheduled.
	AssetDbtJobNextRunHumanized *string `json:"assetDbtJobNextRunHumanized,omitempty"`
	// Schedule of the job that materialized this asset in dbt.
	AssetDbtJobSchedule *string `json:"assetDbtJobSchedule,omitempty"`
	// Human-readable cron schedule of the job that materialized this asset in dbt.
	AssetDbtJobScheduleCronHumanized *string `json:"assetDbtJobScheduleCronHumanized,omitempty"`
	// Status of the job that materialized this asset in dbt.
	AssetDbtJobStatus *string `json:"assetDbtJobStatus,omitempty"`
	// Metadata for this asset in dbt, specifically everything under the 'meta' key in the dbt object.
	AssetDbtMeta *string `json:"assetDbtMeta,omitempty"`
	// Name of the package in which this asset exists in dbt.
	AssetDbtPackageName *string `json:"assetDbtPackageName,omitempty"`
	// Name of the project in which this asset exists in dbt.
	AssetDbtProjectName *string `json:"assetDbtProjectName,omitempty"`
	// URL of the semantic layer proxy for this asset in dbt.
	AssetDbtSemanticLayerProxyUrl *string `json:"assetDbtSemanticLayerProxyUrl,omitempty"`
	// Freshness criteria for the source of this asset in dbt.
	AssetDbtSourceFreshnessCriteria *string `json:"assetDbtSourceFreshnessCriteria,omitempty"`
	// List of tags attached to this asset in dbt.
	AssetDbtTags *[]string `json:"assetDbtTags,omitempty"`
	// All associated dbt test statuses.
	AssetDbtTestStatus *string `json:"assetDbtTestStatus,omitempty"`
	// Unique identifier of this asset in dbt.
	AssetDbtUniqueId *string `json:"assetDbtUniqueId,omitempty"`
	// Name of the icon to use for this asset.
	AssetIcon *atlan.AtlanIcon `json:"assetIcon,omitempty"`
	// List of Monte Carlo incident names attached to this asset.
	AssetMcIncidentNames *[]string `json:"assetMcIncidentNames,omitempty"`
	// List of unique Monte Carlo incident names attached to this asset.
	AssetMcIncidentQualifiedNames *[]string `json:"assetMcIncidentQualifiedNames,omitempty"`
	// List of Monte Carlo incident severities associated with this asset.
	AssetMcIncidentSeverities *[]string `json:"assetMcIncidentSeverities,omitempty"`
	// List of Monte Carlo incident states associated with this asset.
	AssetMcIncidentStates *[]string `json:"assetMcIncidentStates,omitempty"`
	// List of Monte Carlo incident sub-types associated with this asset.
	AssetMcIncidentSubTypes *[]string `json:"assetMcIncidentSubTypes,omitempty"`
	// List of Monte Carlo incident types associated with this asset.
	AssetMcIncidentTypes *[]string `json:"assetMcIncidentTypes,omitempty"`
	// Time (epoch) at which this asset was last synced from Monte Carlo.
	AssetMcLastSyncRunAt *int64 `json:"assetMcLastSyncRunAt,omitempty"`
	// List of Monte Carlo monitor names attached to this asset.
	AssetMcMonitorNames *[]string `json:"assetMcMonitorNames,omitempty"`
	// List of unique Monte Carlo monitor names attached to this asset.
	AssetMcMonitorQualifiedNames *[]string `json:"assetMcMonitorQualifiedNames,omitempty"`
	// Schedules of all associated Monte Carlo monitors.
	AssetMcMonitorScheduleTypes *[]string `json:"assetMcMonitorScheduleTypes,omitempty"`
	// Statuses of all associated Monte Carlo monitors.
	AssetMcMonitorStatuses *[]string `json:"assetMcMonitorStatuses,omitempty"`
	// Types of all associated Monte Carlo monitors.
	AssetMcMonitorTypes *[]string `json:"assetMcMonitorTypes,omitempty"`
	// Number of checks done via Soda.
	AssetSodaCheckCount *int64 `json:"assetSodaCheckCount,omitempty"`
	// All associated Soda check statuses.
	AssetSodaCheckStatuses *string `json:"assetSodaCheckStatuses,omitempty"`
	// Status of data quality from Soda.
	AssetSodaDQStatus *string `json:"assetSodaDQStatus,omitempty"`
	// Time (epoch) at which the last scan via Soda occurred, in milliseconds.
	AssetSodaLastScanAt *int64 `json:"assetSodaLastScanAt,omitempty"`
	// Time (epoch) at which this asset was last synced via Soda, in milliseconds.
	AssetSodaLastSyncRunAt *int64 `json:"assetSodaLastSyncRunAt,omitempty"`
	// URL of the source for Soda.
	AssetSodaSourceURL *string `json:"assetSodaSourceURL,omitempty"`
	// List of tags attached to this asset.
	AssetTags *[]string `json:"assetTags,omitempty"`
	// Glossary terms that are linked to this asset.
	AssignedTerms *[]AtlasGlossaryTerm `json:"assignedTerms,omitempty"`
	// Status of this asset's certification.
	CertificateStatus *atlan.CertificateStatus `json:"certificateStatus,omitempty"`
	// Human-readable descriptive message used to provide further detail to certificateStatus.
	CertificateStatusMessage *string `json:"certificateStatusMessage,omitempty"`
	// Time (epoch) at which the certification was last updated, in milliseconds.
	CertificateUpdatedAt *int64 `json:"certificateUpdatedAt,omitempty"`
	// Name of the user who last updated the certification of this asset.
	CertificateUpdatedBy *string `json:"certificateUpdatedBy,omitempty"`
	// Simple name of the connection through which this asset is accessible.
	ConnectionName *string `json:"connectionName,omitempty"`
	// Unique name of the connection through which this asset is accessible.
	ConnectionQualifiedName *string `json:"connectionQualifiedName,omitempty"`
	// Type of the connector through which this asset is accessible.
	ConnectorType *AtlanConnectorType `json:"connectorType,omitempty"`
	// Unique name of this asset in dbt.
	DbtQualifiedName *string `json:"dbtQualifiedName,omitempty"`
	// Description of this asset, for example as crawled from a source.
	Description *string `json:"description,omitempty"`
	// Human-readable name of this asset used for display purposes (in user interface).
	DisplayName *string `json:"displayText,omitempty"`
	// List of files associated with this asset.
	Files *[]File `json:"files,omitempty"`
	// Whether this asset has lineage (true) or not (false).
	HasLineage *bool `json:"hasLineage,omitempty"`
	// Whether this asset is AI-generated (true) or not (false).
	IsAIGenerated *bool `json:"isAIGenerated,omitempty"`
	// Whether this asset is discoverable through the UI (true) or not (false).
	IsDiscoverable *bool `json:"isDiscoverable,omitempty"`
	// Whether this asset can be edited in the UI (true) or not (false).
	IsEditable *bool `json:"isEditable,omitempty"`
	// Time (epoch) of the last operation that inserted, updated, or deleted rows, in milliseconds.
	LastRowChangedAt *int64 `json:"lastRowChangedAt,omitempty"`
	// Name of the last run of the crawler that last synchronized this asset.
	LastSyncRun *string `json:"lastSyncRun,omitempty"`
	// Time (epoch) at which this asset was last crawled, in milliseconds.
	LastSyncRunAt *int64 `json:"lastSyncRunAt,omitempty"`
	// Name of the crawler that last synchronized this asset.
	LastSyncWorkflowName *string `json:"lastSyncWorkflowName,omitempty"`
	// Links that are attached to this asset.
	Links *[]Link `json:"links,omitempty"`
	// Monte Carlo incidents associated with this asset.
	McIncidents *[]MCIncident `json:"mcIncidents,omitempty"`
	// Monte Carlo monitors that observe this asset.
	McMonitors *[]MCMonitor `json:"mcMonitors,omitempty"`
	// Metrics associated with this asset.
	Metrics *[]Metric `json:"metrics,omitempty"`
	// Name of this asset.
	Name *string `json:"name,omitempty"`
	// List of groups who own this asset.
	OwnerGroups *[]string `json:"ownerGroups,omitempty"`
	// List of users who own this asset.
	OwnerUsers *[]string `json:"ownerUsers,omitempty"`
	// Popularity score for this asset.
	PopularityScore *float64 `json:"popularityScore,omitempty"`
	// README that is linked to this asset.
	Readme *Readme `json:"readme,omitempty"`
	// URL for sample data for this asset.
	SampleDataUrl *string `json:"sampleDataUrl,omitempty"`
	// Subjects in the schema registry for this asset.
	SchemaRegistrySubjects *[]SchemaRegistrySubject `json:"schemaRegistrySubjects,omitempty"`
	// Soda checks associated with this asset.
	SodaChecks *[]SodaCheck `json:"sodaChecks,omitempty"`
	// Unit of measure for sourceTotalCost.
	SourceCostUnit *SourceCostUnitType `json:"sourceCostUnit,omitempty"`
	// Time (epoch) at which this asset was created in the source system, in milliseconds.
	SourceCreatedAt *int64 `json:"sourceCreatedAt,omitempty"`
	// User who created this asset in the source system.
	SourceCreatedBy *string `json:"sourceCreatedBy,omitempty"`
	// URL to create an embed for a resource (for example, an image of a dashboard) within Atlan.
	SourceEmbedURL *string `json:"sourceEmbedURL,omitempty"`
	// Timestamp of most recent read operation.
	SourceLastReadAt *int64 `json:"sourceLastReadAt,omitempty"`
	// Owners of this asset in the source system.
	SourceOwners *string `json:"sourceOwners,omitempty"`
	// Records of most expensive warehouse with extra insights.
	SourceQueryComputeCostRecords *[]PopularityInsights `json:"sourceQueryComputeCostRecords,omitempty"`
	// Names of most expensive warehouses.
	SourceQueryComputeCosts *[]string `json:"sourceQueryComputeCosts,omitempty"`
	// Total count of all read operations at source.
	SourceReadCount *int64 `json:"sourceReadCount,omitempty"`
	// Records of most expensive queries that accessed this asset.
	SourceReadExpensiveQueryRecords *[]PopularityInsights `json:"sourceReadExpensiveQueryRecords,omitempty"`
	// Records of most popular queries that accessed this asset.
	SourceReadPopularQueryRecords *[]PopularityInsights `json:"sourceReadPopularQueryRecords,omitempty"`
	// Total cost of read queries at source.
	SourceReadQueryCost *float64 `json:"sourceReadQueryCost,omitempty"`
	// Records of most recent users who read this asset.
	SourceReadRecentUserRecords *[]PopularityInsights `json:"sourceReadRecentUserRecords,omitempty"`
	// Names of most recent users who read this asset.
	SourceReadRecentUsers *[]string `json:"sourceReadRecentUsers,omitempty"`
	// Records of slowest queries that accessed this asset.
	SourceReadSlowQueryRecords *[]PopularityInsights `json:"sourceReadSlowQueryRecords,omitempty"`
	// Records of users who read this asset the most.
	SourceReadTopUserRecords *[]PopularityInsights `json:"sourceReadTopUserRecords,omitempty"`
	// Names of users who read this asset the most.
	SourceReadTopUsers *[]string `json:"sourceReadTopUsers,omitempty"`
	// Total number of unique users that read data from asset.
	SourceReadUserCount *int64 `json:"sourceReadUserCount,omitempty"`
	// Total cost of all operations at source.
	SourceTotalCost *float64 `json:"sourceTotalCost,omitempty"`
	// URL to the resource within the source application.
	SourceURL *string `json:"sourceURL,omitempty"`
	// Time (epoch) at which this asset was last updated in the source system, in milliseconds.
	SourceUpdatedAt *int64 `json:"sourceUpdatedAt,omitempty"`
	// User who last updated this asset in the source system.
	SourceUpdatedBy *string `json:"sourceUpdatedBy,omitempty"`
	// Users who have starred this asset.
	StarredBy *[]string `json:"starredBy,omitempty"`
	// Number of users who have starred this asset.
	StarredCount *int `json:"starredCount,omitempty"`
	// Details of users who have starred this asset.
	StarredDetails *[]StarredDetails `json:"starredDetails,omitempty"`
	// Subtype of this asset.
	SubType *string `json:"subType,omitempty"`
	// Name of the Atlan workspace in which this asset exists.
	TenantId *string `json:"tenantId,omitempty"`
	// Description of this asset as provided by a user.
	UserDescription *string `json:"userDescription,omitempty"`
	// View score for this asset.
	ViewScore *float64 `json:"viewScore,omitempty"`
	// List of groups who can view assets contained in a collection.
	ViewerGroups *[]string `json:"viewerGroups,omitempty"`
	// List of users who can view assets contained in a collection.
	ViewerUsers *[]string `json:"viewerUsers,omitempty"`
	// Internal tracking of fields that should be serialized with null values.
	NullFields *[]string `json:"nullFields,omitempty"`
	// Atlan tags assigned to the asset.
	AtlanTags *[]AtlanTag `json:"classifications,omitempty"`
	// Map of custom metadata attributes and values defined on the asset.
	CustomMetadataSets map[string]map[string]interface{} `json:"customMetadataSets,omitempty"`
	// Time (epoch) at which the asset was created, in milliseconds.
	CreateTime *int64 `json:"createTime,omitempty"`
	// Time (epoch) at which the asset was last updated, in milliseconds.
	UpdateTime *int64 `json:"updateTime,omitempty"`
	// Details on the handler used for deletion of the asset.
	DeleteHandler *string `json:"deleteHandler,omitempty"`
	// Names of the Atlan tags that exist on the asset.
	AtlanTagNames *[]string `json:"classificationNames,omitempty"`
	// Unused.
	IsIncomplete *bool `json:"isIncomplete,omitempty"`
	// Names of terms that have been linked to this asset.
	MeaningNames *[]string `json:"meaningNames,omitempty"`
	// Details of terms that have been linked to this asset.
	Meanings *[]AtlasGlossaryTerm `json:"meanings,omitempty"`
	// Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset.
	PendingTasks *[]string `json:"pendingTasks,omitempty"`

	DisplayText *string `json:"displayName,omitempty"`
}

type AtlanConnectorType 

type AtlanConnectorType string

type AtlanGroup added in v0.0.13 

type AtlanGroup struct {
	Alias              *string               `json:"alias,omitempty"`              // Name of the group as it appears in the UI.
	Attributes         *AtlanGroupAttributes `json:"attributes,omitempty"`         // Detailed attributes of the group.
	DecentralizedRoles []interface{}         `json:"decentralizedRoles,omitempty"` // Decentralized roles associated with the group (TBC).
	ID                 *string               `json:"id,omitempty"`                 // Unique identifier for the group (GUID).
	Name               *string               `json:"name,omitempty"`               // Unique (internal) name for the group.
	Path               *string               `json:"path,omitempty"`               // TBC
	Personas           []Persona             `json:"personas,omitempty"`           // Personas the group is associated with.
	Purposes           []interface{}         `json:"purposes,omitempty"`           // Purposes the group is associated with.
	UserCount          *int                  `json:"userCount,omitempty"`          // Number of users in the group.
}

AtlanGroup represents a group in Atlan with detailed attributes.

type AtlanGroupAttributes added in v0.0.13 

type AtlanGroupAttributes struct {
	Alias       []string `json:"alias,omitempty"`       // Name of the group as it appears in the UI.
	CreatedAt   []string `json:"createdAt,omitempty"`   // Time (epoch) at which the group was created, in milliseconds.
	CreatedBy   []string `json:"createdBy,omitempty"`   // User who created the group.
	UpdatedAt   []string `json:"updatedAt,omitempty"`   // Time (epoch) at which the group was last updated, in milliseconds.
	UpdatedBy   []string `json:"updatedBy,omitempty"`   // User who last updated the group.
	Description []string `json:"description,omitempty"` // Description of the group.
	IsDefault   []string `json:"isDefault,omitempty"`   // Whether this group should be auto-assigned to all new users or not.
	Channels    []string `json:"channels,omitempty"`    // Slack channels for this group.
}

AtlanGroupAttributes represents detailed attributes of an Atlan group.

type AtlanIcon 

type AtlanIcon string

type AtlanRole added in v0.0.13 

type AtlanRole struct {
	// Unique identifier for the role (GUID).
	ID *string `json:"id,omitempty"`
	// Unique name for the role.
	Name *string `json:"name"`
	// Description of the role.
	Description *string `json:"description,omitempty"`
	ClientRole  *bool   `json:"client_role,omitempty"`
	Level       *string `json:"level,omitempty"`
	// Number of users with this role.
	MemberCount *string `json:"member_count,omitempty"`
	UserCount   *string `json:"user_count,omitempty"`
}

AtlanRole represents a role in Atlan.

type AtlanTag 

type AtlanTag struct {
	TypeName                            *string `json:"typeName"`
	EntityGuid                          *string `json:"entityGuid,omitempty"`
	EntityStatus                        *string `json:"entityStatus,omitempty"`
	Propagate                           *bool   `json:"propagate,omitempty"`
	RemovePropagationsOnEntityDelete    *bool   `json:"removePropagationsOnEntityDelete,omitempty"`
	RestrictPropagationThroughLineage   *bool   `json:"restrictPropagationThroughLineage,omitempty"`
	RestrictPropagationThroughHierarchy *bool   `json:"restrictPropagationThroughHierarchy,omitempty"`
}

AtlanTag represents a tag in Atlan.

type AtlanTagName added in v0.0.14 

type AtlanTagName struct {
	ID          string `json:"id,omitempty"`
	DisplayText string `json:"displayText,omitempty"`
}

AtlanTagName represents the attributes of the AtlanTagName asset.

type AtlanUser added in v0.0.13 

type AtlanUser struct {
	Asset
	ID             string          `json:"id"`                      // Unique identifier (GUID) of the user within Atlan.
	Username       *string         `json:"username,omitempty"`      // Username of the user within Atlan.
	WorkspaceRole  string          `json:"workspaceRole"`           // Name of the role of the user within Atlan.
	Email          string          `json:"email"`                   // Email address of the user.
	EmailVerified  *bool           `json:"emailVerified,omitempty"` // When true, the email address of the user has been verified.
	Enabled        *bool           `json:"enabled,omitempty"`       // When true, the user is enabled. When false, the user has been deactivated.
	FirstName      *string         `json:"firstName,omitempty"`     // First name of the user.
	LastName       *string         `json:"lastName,omitempty"`      // Last name (surname) of the user.
	Attributes     *UserAttributes `json:"attributes,omitempty"`    // Detailed attributes of the user.
	CreatedAt      *string         `json:"CreatedAt,omitempty"`     // Time (epoch) at which the user was created, in milliseconds.
	LastLoginTime  *int            `json:"lastLoginTime,omitempty"` // Time (epoch) at which the user last logged into Atlan
	GroupCount     *int            `json:"groupCount,omitempty"`    // Number of groups to which the user belongs
	DefaultRoles   *[]string       `json:"defaultRoles,omitempty"`
	Roles          *[]string       `json:"roles,omitempty"`
	DecentralRoles interface{}     `json:"decentralizedRoles,omitempty"` // TBD
	Personas       *[]Persona      `json:"personas,omitempty"`           // Personas the user is associated with.
	Purposes       []interface{}   `json:"purposes,omitempty"`           // TBD
	AdminEvents    *[]AdminEvent   `json:"adminEvents,omitempty"`        // List of administration-related events for this user.
	LoginEvents    *[]LoginEvent   `json:"loginEvents,omitempty"`        // List of login-related events for this user.
}

AtlanUser represents an Atlan user.

type AtlasGlossary 

type AtlasGlossary struct {
	Relation
	Asset
	ShortDescription     *string                  `json:"shortDescription,omitempty"`
	LongDescription      *string                  `json:"longDescription,omitempty"`
	Language             *string                  `json:"language,omitempty"`
	Usage                *string                  `json:"usage,omitempty"`
	AdditionalAttributes *map[string]string       `json:"additionalAttributes,omitempty"`
	Terms                *[]AtlasGlossaryTerm     `json:"terms,omitempty"`
	Categories           *[]AtlasGlossaryCategory `json:"categories,omitempty"`
}

type AtlasGlossaryAttributes 

type AtlasGlossaryAttributes AtlasGlossary

type AtlasGlossaryCategory 

type AtlasGlossaryCategory struct {
	Asset
	AdditionalAttributes map[string]string       `json:"additionalAttributes"`
	Anchor               []AtlasGlossary         `json:"anchor"`
	ChildrenCategories   []AtlasGlossaryCategory `json:"childrenCategories"`
	LongDescription      string                  `json:"longDescription"`
	ParentCategory       []AtlasGlossaryCategory `json:"parentCategory"`
	ShortDescription     string                  `json:"shortDescription"`
	Terms                []AtlasGlossaryTerm     `json:"terms"`
}

type AtlasGlossaryTerm 

type AtlasGlossaryTerm struct {
	Asset
	ShortDescription     *string              `json:"shortDescription,omitempty"`
	LongDescription      *string              `json:"longDescription,omitempty"`
	Example              *string              `json:"example,omitempty"`
	Abbreviation         *string              `json:"abbreviation,omitempty"`
	Usage                *string              `json:"usage,omitempty"`
	AdditionalAttributes *map[string]string   `json:"additionalAttributes,omitempty"`
	Anchor               *AtlasGlossary       `json:"anchor,omitempty"`
	Antonyms             *[]AtlasGlossaryTerm `json:"antonyms,omitempty"`
	AssignedEntities     *[]Asset             `json:"assignedEntities,omitempty"`
	Categories           *[]AtlasGlossaryTerm `json:"categories,omitempty"`
	ValidValuesFor       *[]AtlasGlossaryTerm `json:"validValuesFor,omitempty"`
	ValidValues          *[]AtlasGlossaryTerm `json:"validValues,omitempty"`
	SeeAlso              *[]AtlasGlossaryTerm `json:"seeAlso,omitempty"`
	IsA                  *[]AtlasGlossaryTerm `json:"isA,omitempty"`
	CLASSIFIES           *[]AtlasGlossaryTerm `json:"classifies,omitempty"`
	PreferredToTerms     *[]AtlasGlossaryTerm `json:"preferredToTerms,omitempty"`
	PreferredTerms       *[]AtlasGlossaryTerm `json:"preferredTerms,omitempty"`
	TranslationTerms     *[]AtlasGlossaryTerm `json:"translationTerms,omitempty"`
	Synonyms             *[]AtlasGlossaryTerm `json:"synonyms,omitempty"`
	ReplacedBy           *[]AtlasGlossaryTerm `json:"replacedBy,omitempty"`
	ReplacementTerms     *[]AtlasGlossaryTerm `json:"replacementTerms,omitempty"`
	TranslatedTerms      *[]AtlasGlossaryTerm `json:"translatedTerms,omitempty"`
}

func (*AtlasGlossaryTerm) FromJSON 

func (ag *AtlasGlossaryTerm) FromJSON(data []byte) error

func (*AtlasGlossaryTerm) ToJSON 

func (gt *AtlasGlossaryTerm) ToJSON() ([]byte, error)

func (*AtlasGlossaryTerm) UnmarshalJSON 

func (gt *AtlasGlossaryTerm) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals the JSON data into a GlossaryTerm object.

type AtlasGlossaryTermAttributes 

type AtlasGlossaryTermAttributes struct {
	Asset
	ShortDescription     *string              `json:"shortDescription,omitempty"`
	LongDescription      *string              `json:"longDescription,omitempty"`
	Example              *string              `json:"example,omitempty"`
	Abbreviation         *string              `json:"abbreviation,omitempty"`
	Usage                *string              `json:"usage,omitempty"`
	AdditionalAttributes *map[string]string   `json:"additionalAttributes,omitempty"`
	Anchor               *_Glossary           `json:"anchor,omitempty"`
	Antonyms             *[]AtlasGlossaryTerm `json:"antonyms,omitempty"`
	AssignedEntities     *[]Asset             `json:"assignedEntities,omitempty"`
	Categories           *[]AtlasGlossaryTerm `json:"categories,omitempty"`
	ValidValuesFor       *[]AtlasGlossaryTerm `json:"validValuesFor,omitempty"`
	ValidValues          *[]AtlasGlossaryTerm `json:"validValues,omitempty"`
	SeeAlso              *[]AtlasGlossaryTerm `json:"seeAlso,omitempty"`
	IsA                  *[]AtlasGlossaryTerm `json:"isA,omitempty"`
	CLASSIFIES           *[]AtlasGlossaryTerm `json:"classifies,omitempty"`
	PreferredToTerms     *[]AtlasGlossaryTerm `json:"preferredToTerms,omitempty"`
	PreferredTerms       *[]AtlasGlossaryTerm `json:"preferredTerms,omitempty"`
	TranslationTerms     *[]AtlasGlossaryTerm `json:"translationTerms,omitempty"`
	Synonyms             *[]AtlasGlossaryTerm `json:"synonyms,omitempty"`
	ReplacedBy           *[]AtlasGlossaryTerm `json:"replacedBy,omitempty"`
	ReplacementTerms     *[]AtlasGlossaryTerm `json:"replacementTerms,omitempty"`
	TranslatedTerms      *[]AtlasGlossaryTerm `json:"translatedTerms,omitempty"`
}

type Attributes 

type Attributes struct {
	PopularityScore     float64 `json:"popularityScore"`
	AssetMcMonitorNames []string
	LastSyncRunAt       int64 `json:"lastSyncRunAt"`

	SourceQueryComputeCostRecordList      []interface{}
	AssetSodaLastSyncRunAt                int64 `json:"assetSodaLastSyncRunAt"`
	StarredCount                          int
	AdminUsers                            []interface{}
	LastRowChangedAt                      int64 `json:"lastRowChangedAt"`
	SourceReadRecentUserList              []interface{}
	AssetMcIncidentQualifiedNames         []interface{}
	AssetMcIncidentTypes                  []interface{}
	AssetSodaLastScanAt                   int64 `json:"assetSodaLastScanAt"`
	SourceUpdatedAt                       int64 `json:"sourceUpdatedAt"`
	AssetDbtJobLastRunArtifactsSaved      bool
	StarredDetailsList                    []interface{}
	IsEditable                            bool `json:"isEditable"`
	SourceReadCount                       int
	AnnouncementUpdatedAt                 int64 `json:"announcementUpdatedAt"`
	SourceCreatedAt                       int64 `json:"sourceCreatedAt"`
	AssetDbtJobLastRunDequedAt            int64 `json:"assetDbtJobLastRunDequedAt"`
	AssetDbtTags                          []interface{}
	SourceReadSlowQueryRecordList         []interface{}
	QualifiedName                         string `json:"qualifiedName"`
	SourceQueryComputeCostList            []interface{}
	AssetDbtJobLastRunNotificationsSent   bool
	AssetMcMonitorTypes                   []interface{}
	AssetSodaCheckCount                   int
	AssetMcMonitorStatuses                []interface{}
	StarredBy                             []interface{}
	SourceLastReadAt                      int64 `json:"sourceLastReadAt"`
	Name                                  string
	CertificateUpdatedAt                  int64 `json:"certificateUpdatedAt"`
	AssetMcIncidentSeverities             []interface{}
	SourceReadQueryCost                   float64 `json:"sourceReadQueryCost"`
	OwnerUsers                            []interface{}
	AssetDbtJobLastRunHasSourcesGenerated bool
	AssetMcIncidentSubTypes               []interface{}
	IsAIGenerated                         bool `json:"isAIGenerated"`
	AssetDbtJobLastRunHasDocsGenerated    bool `json:"assetDbtJobLastRunHasDocsGenerated"`
	AssetTags                             []interface{}
	AssetMcIncidentStates                 []interface{}
	AssetDbtJobLastRunUpdatedAt           int64 `json:"assetDbtJobLastRunUpdatedAt"`
	OwnerGroups                           []interface{}
	AssetMcMonitorQualifiedNames          []interface{}
	SourceReadExpensiveQueryRecordList    []interface{}
	AssetDbtJobLastRunStartedAt           int64 `json:"assetDbtJobLastRunStartedAt"`
	IsDiscoverable                        bool  `json:"isDiscoverable"`
	IsPartial                             bool  `json:"isPartial"`
	SourceReadTopUserRecordList           []interface{}
	AssetMcMonitorScheduleTypes           []interface{}
	ViewerUsers                           []interface{}
	ViewScore                             float64 `json:"viewScore"`
	SourceReadTopUserList                 []interface{}
	AssetMcIncidentNames                  []interface{}
	AdminRoles                            []interface{}
	AdminGroups                           []interface{}
	AssetDbtJobLastRunCreatedAt           int64 `json:"assetDbtJobLastRunCreatedAt"`
	AssetDbtJobNextRun                    int64 `json:"assetDbtJobNextRun"`
	SourceReadRecentUserRecordList        []interface{}
	AssetIcon                             string `json:"assetIcon"`
	SourceReadPopularQueryRecordList      []interface{}
	SourceTotalCost                       float64 `json:"sourceTotalCost"`
	AssetMcLastSyncRunAt                  int64   `json:"assetMcLastSyncRunAt"`
	SourceReadUserCount                   int
	ViewerGroups                          []interface{}
	AssetDbtJobLastRun                    int64 `json:"assetDbtJobLastRun"`
	// contains filtered or unexported fields
}

type AuthDetails added in v0.0.13 

type AuthDetails struct {
	ClientID  *string `json:"clientID,omitempty"`
	IPAddress *string `json:"ipAddress,omitempty"`
	RealmID   *string `json:"realmID,omitempty"`
	UserID    *string `json:"userID,omitempty"`
}

AuthDetails represents authentication details for admin operations.

type AuthPolicy added in v0.0.12 

type AuthPolicy struct {
	Asset
	UniqueAttributes struct {
		QualifiedName *string `json:"qualifiedName"`
	} `json:"uniqueAttributes"`
	PolicyType              *atlan.AuthPolicyType               `json:"policyType,omitempty"`
	PolicyServiceName       *string                             `json:"policyServiceName,omitempty"`
	PolicyCategory          *string                             `json:"policyCategory,omitempty"`
	PolicySubCategory       *string                             `json:"policySubCategory,omitempty"`
	PolicyUsers             *[]string                           `json:"policyUsers,omitempty"`
	PolicyGroups            *[]string                           `json:"policyGroups,omitempty"`
	PolicyRoles             *[]string                           `json:"policyRoles,omitempty"`
	PolicyActions           *[]string                           `json:"policyActions,omitempty"`
	PolicyResources         *[]string                           `json:"policyResources,omitempty"`
	PolicyResourceCategory  *string                             `json:"policyResourceCategory,omitempty"`
	PolicyPriority          *int                                `json:"policyPriority,omitempty"`
	IsPolicyEnabled         *bool                               `json:"isPolicyEnabled,omitempty"`
	PolicyMaskType          *atlan.DataMaskingType              `json:"policyMaskType,omitempty"`
	PolicyValiditySchedule  *[]atlan.AuthPolicyValiditySchedule `json:"policyValiditySchedule,omitempty"`
	PolicyResourceSignature *string                             `json:"policyResourceSignature,omitempty"`
	PolicyDelegateAdmin     *bool                               `json:"policyDelegateAdmin,omitempty"`
	PolicyConditions        *[]atlan.AuthPolicyCondition        `json:"policyConditions,omitempty"`
	AccessControl           *AccessControl                      `json:"accessControl,omitempty"` // Relationship
}

AuthPolicy represents a policy with various attributes.

type Catalog 

type Catalog struct {
	Asset
	InputToProcesses       *[]Process     `json:"inputToProcesses,omitempty"`
	InputToAirFlowTasks    *[]AirFlowTask `json:"inputToAirFlowTasks,omitempty"`
	OutputFromProcesses    *[]Process     `json:"outputFromProcesses,omitempty"`
	OutputFromAirFlowTasks *[]AirFlowTask `json:"outputFromAirFlowTasks,omitempty"`
}

type CertificateStatus 

type CertificateStatus string

type Column 

type Column struct {
	SQL
	DataType                       *string                    `json:"dataType,omitempty"`
	SubDataType                    *string                    `json:"subDataType,omitempty"`
	RawDataTypeDefinition          *string                    `json:"rawDataTypeDefinition,omitempty"`
	Order                          *int                       `json:"order,omitempty"`
	NestedColumnCount              *int                       `json:"nestedColumnCount,omitempty"`
	IsPartition                    *bool                      `json:"isPartition,omitempty"`
	PartitionOrder                 *int                       `json:"partitionOrder,omitempty"`
	IsClustered                    *bool                      `json:"isClustered,omitempty"`
	IsPrimary                      *bool                      `json:"isPrimary,omitempty"`
	IsForeign                      *bool                      `json:"isForeign,omitempty"`
	IsIndexed                      *bool                      `json:"isIndexed,omitempty"`
	IsSort                         *bool                      `json:"isSort,omitempty"`
	IsDist                         *bool                      `json:"isDist,omitempty"`
	IsPinned                       *bool                      `json:"isPinned,omitempty"`
	PinnedBy                       *string                    `json:"pinnedBy,omitempty"`
	PinnedAt                       *time.Time                 `json:"pinnedAt,omitempty"`
	Precision                      *int                       `json:"precision,omitempty"`
	DefaultValue                   *string                    `json:"defaultValue,omitempty"`
	IsNullable                     *bool                      `json:"isNullable,omitempty"`
	NumericScale                   *float64                   `json:"numericScale,omitempty"`
	MaxLength                      *int                       `json:"maxLength,omitempty"`
	Validations                    map[string]string          `json:"validations,omitempty"`
	ParentColumnQualifiedName      *string                    `json:"parentColumnQualifiedName,omitempty"`
	ParentColumnName               *string                    `json:"parentColumnName,omitempty"`
	ColumnDistinctValuesCount      *int                       `json:"columnDistinctValuesCount,omitempty"`
	ColumnDistinctValuesCountLong  *int                       `json:"columnDistinctValuesCountLong,omitempty"`
	ColumnHistogram                *Histogram                 `json:"columnHistogram,omitempty"`
	ColumnMax                      *float64                   `json:"columnMax,omitempty"`
	ColumnMin                      *float64                   `json:"columnMin,omitempty"`
	ColumnMean                     *float64                   `json:"columnMean,omitempty"`
	ColumnSum                      *float64                   `json:"columnSum,omitempty"`
	ColumnMedian                   *float64                   `json:"columnMedian,omitempty"`
	ColumnStandardDeviation        *float64                   `json:"columnStandardDeviation,omitempty"`
	ColumnUniqueValuesCount        *int                       `json:"columnUniqueValuesCount,omitempty"`
	ColumnUniqueValuesCountLong    *int                       `json:"columnUniqueValuesCountLong,omitempty"`
	ColumnAverage                  *float64                   `json:"columnAverage,omitempty"`
	ColumnAverageLength            *float64                   `json:"columnAverageLength,omitempty"`
	ColumnDuplicateValuesCount     *int                       `json:"columnDuplicateValuesCount,omitempty"`
	ColumnDuplicateValuesCountLong *int                       `json:"columnDuplicateValuesCountLong,omitempty"`
	ColumnMaximumStringLength      *int                       `json:"columnMaximumStringLength,omitempty"`
	ColumnMaxs                     *map[string]bool           `json:"columnMaxs,omitempty"`
	ColumnMinimumStringLength      *int                       `json:"columnMinimumStringLength,omitempty"`
	ColumnMins                     *map[string]bool           `json:"columnMins,omitempty"`
	ColumnMissingValuesCount       *int                       `json:"columnMissingValuesCount,omitempty"`
	ColumnMissingValuesCountLong   *int                       `json:"columnMissingValuesCountLong,omitempty"`
	ColumnMissingValuesPercentage  *float64                   `json:"columnMissingValuesPercentage,omitempty"`
	ColumnUniquenessPercentage     *float64                   `json:"columnUniquenessPercentage,omitempty"`
	ColumnVariance                 *float64                   `json:"columnVariance,omitempty"`
	ColumnTopValues                []*ColumnValueFrequencyMap `json:"columnTopValues,omitempty"`
	ColumnDepthLevel               *int                       `json:"columnDepthLevel,omitempty"`
	SnowflakeDynamicTable          *SnowflakeDynamicTable     `json:"snowflakeDynamicTable,omitempty"`
	View                           *View                      `json:"view,omitempty"`
	NestedColumns                  []*Column                  `json:"nestedColumns,omitempty"`
	DataQualityMetricDimensions    []*Metric                  `json:"dataQualityMetricDimensions,omitempty"`
	DbtModelColumns                []*DbtModelColumn          `json:"dbtModelColumns,omitempty"`
	Table                          *Table                     `json:"table,omitempty"`
	ColumnDbtModelColumns          []*DbtModelColumn          `json:"columnDbtModelColumns,omitempty"`
	MaterialisedView               *MaterialisedView          `json:"materialisedView,omitempty"`
	ParentColumn                   *Column                    `json:"parentColumn,omitempty"`
	Queries                        []*Query                   `json:"queries,omitempty"`
	MetricTimestamps               []*Metric                  `json:"metricTimestamps,omitempty"`
	ForeignKeyTo                   []*Column                  `json:"foreignKeyTo,omitempty"`
	ForeignKeyFrom                 *Column                    `json:"foreignKeyFrom,omitempty"`
	DbtMetrics                     []*DbtMetric               `json:"dbtMetrics,omitempty"`
	TablePartition                 *TablePartition            `json:"tablePartition,omitempty"`
}

type ColumnValueFrequencyMap 

type ColumnValueFrequencyMap string

type Connection 

type Connection struct {
	Asset
	Category                     *string                      `json:"category,omitempty"`
	SubCategory                  *string                      `json:"subCategory,omitempty"`
	Host                         *string                      `json:"host,omitempty"`
	Port                         *int                         `json:"port,omitempty"`
	AllowQuery                   *bool                        `json:"allowQuery,omitempty"`
	AllowQueryPreview            *bool                        `json:"allowQueryPreview,omitempty"`
	QueryPreviewConfig           *map[string]string           `json:"queryPreviewConfig,omitempty"`
	QueryConfig                  *string                      `json:"queryConfig,omitempty"`
	CredentialStrategy           *string                      `json:"credentialStrategy,omitempty"`
	PreviewCredentialStrategy    *string                      `json:"previewCredentialStrategy,omitempty"`
	PolicyStrategy               *string                      `json:"policyStrategy,omitempty"`
	QueryUsernameStrategy        *atlan.QueryUsernameStrategy `json:"queryUsernameStrategy,omitempty"`
	RowLimit                     *int                         `json:"rowLimit,omitempty"`
	QueryTimeout                 *int                         `json:"queryTimeout,omitempty"`
	DefaultCredentialGuid        *string                      `json:"defaultCredentialGuid,omitempty"`
	ConnectorIcon                *string                      `json:"connectorIcon,omitempty"`
	ConnectorImage               *string                      `json:"connectorImage,omitempty"`
	IsSampleDataPreviewEnabled   *bool                        `json:"isSampleDataPreviewEnabled,omitempty"`
	PopularityInsightsTimeframe  *int                         `json:"popularityInsightsTimeframe,omitempty"`
	HasPopularityInsights        *bool                        `json:"hasPopularityInsights,omitempty"`
	ConnectionDbtEnvironments    *map[string]bool             `json:"connectionDbtEnvironments,omitempty"`
	ConnectionSSOCredentialGuid  *string                      `json:"connectionSSOCredentialGuid,omitempty"`
	UseObjectStorage             *bool                        `json:"useObjectStorage,omitempty"`
	ObjectStorageUploadThreshold *int                         `json:"objectStorageUploadThreshold,omitempty"`
	VectorEmbeddingsEnabled      *bool                        `json:"vectorEmbeddingsEnabled,omitempty"`
	VectorEmbeddingsUpdatedAt    *time.Time                   `json:"vectorEmbeddingsUpdatedAt,omitempty"`
}

type CreateGroupResponse added in v0.0.13 

type CreateGroupResponse struct {
	Group string                 // Unique identifier (GUID) of the group that was created.
	Users map[string]*UserStatus // Map of user association statuses, keyed by user GUID.
}

CreateGroupResponse represents the response for creating a group.

type DataContract 

type DataContract struct {
	Catalog
	Version    *string                 `json:"dataContractVersion,omitempty"`
	AssetGuid  *string                 `json:"dataContractAssetGuid,omitempty"`
	Attributes *DataContractAttributes `json:"attributes,omitempty"`
	// Relationships
	LatestCertified         *[]Asset        `json:"dataContractLatestCertified,omitempty"`
	ContractAssetCertified  *[]DataContract `json:"dataContractAssetCertified,omitempty"`
	ContractLatest          *[]Asset        `json:"dataContractLatest,omitempty"`
	ContractAssetLatest     *[]DataContract `json:"dataContractAssetLatest,omitempty"`
	ContractPreviousVersion *[]DataContract `json:"dataContractPreviousVersion,omitempty"`
	ContractNextVersion     *[]DataContract `json:"dataContractNextVersion,omitempty"`
}

type DataContractAttributes 

type DataContractAttributes struct {
	Name              *string `json:"name,omitempty"`
	CertificateStatus *string `json:"certificateStatus,omitempty"`
	QualifiedName     *string `json:"qualifiedName,omitempty"`
	DataContractJson  *string `json:"dataContractJson,omitempty"`
	DataContractSpec  *string `json:"dataContractSpec,omitempty"`
}

type DbtMetric 

type DbtMetric struct {
}

type DbtModel 

type DbtModel struct {
}

type DbtModelColumn 

type DbtModelColumn struct {
}

type DbtSource 

type DbtSource struct {
}

type DbtTest 

type DbtTest struct {
}

type File 

type File string

type GroupRequest added in v0.0.13 

type GroupRequest struct {
	PostFilter *string `json:"postFilter,omitempty"` // Criteria for filtering groups.
	Sort       string  `json:"sort,omitempty"`       // Property to sort groups by (default: "name").
	Count      bool    `json:"count,omitempty"`      // Include the overall count of groups.
	Offset     int     `json:"offset,omitempty"`     // Starting offset for pagination.
	Limit      int     `json:"limit,omitempty"`      // Maximum number of groups to return per page.
}

GroupRequest represents the request for querying groups.

func (*GroupRequest) QueryParams added in v0.0.13 

func (gr *GroupRequest) QueryParams() map[string]interface{}

QueryParams converts the request into a map of query parameters.

type Histogram 

type Histogram string
type Link struct {
	Guid                   string                 `json:"guid"`
	TypeName               string                 `json:"typeName"`
	EntityStatus           string                 `json:"entityStatus"`
	DisplayText            string                 `json:"displayText"`
	RelationshipType       string                 `json:"relationshipType"`
	RelationshipGuid       string                 `json:"relationshipGuid"`
	RelationshipStatus     string                 `json:"relationshipStatus"`
	RelationshipAttributes map[string]interface{} `json:"relationshipAttributes"`
}

type LoginEvent added in v0.0.13 

type LoginEvent struct {
	ClientID  *string `json:"clientID,omitempty"` // Where the login occurred (usually `atlan-frontend`).
	Details   any     `json:"details,omitempty"`
	IPAddress *string `json:"ipAddress,omitempty"` // IP address from which the user logged in.
	RealmID   *string `json:"realmID,omitempty"`
	SessionID *string `json:"sessionID,omitempty"` // Unique identifier (GUID) of the session for the login.
	Time      *int64  `json:"time,omitempty"`      // Time (epoch) when the login occurred, in milliseconds.
	Type      *string `json:"type,omitempty"`      // Type of login event that occurred (usually `LOGIN`).
	UserID    *string `json:"userID,omitempty"`    // Unique identifier (GUID) of the user that logged in.
}

LoginEvent represents a login event for an Atlan user.

type MCIncident 

type MCIncident string

type MCMonitor 

type MCMonitor string

type MaterialisedView 

type MaterialisedView struct {
	SQL
}

type MaterializedView 

type MaterializedView struct {
	SQL
	RefreshMode        *string            `json:"refreshMode,omitempty"`
	RefreshMethod      *string            `json:"refreshMethod,omitempty"`
	Staleness          *string            `json:"staleness,omitempty"`
	StaleSinceDate     *time.Time         `json:"staleSinceDate,omitempty"`
	ColumnCount        *int               `json:"columnCount,omitempty"`
	RowCount           *int               `json:"rowCount,omitempty"`
	SizeBytes          *int               `json:"sizeBytes,omitempty"`
	IsQueryPreview     *bool              `json:"isQueryPreview,omitempty"`
	QueryPreviewConfig *map[string]string `json:"queryPreviewConfig,omitempty"`
	Alias              *string            `json:"alias,omitempty"`
	IsTemporary        *bool              `json:"isTemporary,omitempty"`
	Definition         *string            `json:"definition,omitempty"`
	Columns            []*Column          `json:"columns,omitempty"`
	AtlanSchema        *Schema            `json:"atlanSchema,omitempty"`
}

type Meaning 

type Meaning string

type Metric 

type Metric struct {
}

type NameValuePair added in v0.0.16 

type NameValuePair struct {
	Name  string      `json:"name"`
	Value interface{} `json:"value"`
}

NameValuePair represents a name-value pair.

type PackageParameter added in v0.0.16 

type PackageParameter struct {
	Parameter string          `json:"parameter"`
	Type      string          `json:"type"`
	Body      json.RawMessage `json:"body"`
}

PackageParameter represents package-related parameters.

type Persona added in v0.0.12 

type Persona struct {
	AccessControl
	PersonaGroups *[]string `json:"personaGroups,omitempty"`
	PersonaUsers  *[]string `json:"personaUsers,omitempty"`
	RoleId        *string   `json:"roleId,omitempty"`
}

Persona represents the attributes of the Persona asset.

type PopularityInsights 

type PopularityInsights int

type Process 

type Process struct {
	Asset
}

type Purpose added in v0.0.14 

type Purpose struct {
	AccessControl
	Attributes *PurposeAttributes `json:"attributes,omitempty"`
}

type PurposeAttributes added in v0.0.14 

type PurposeAttributes struct {
	PurposeAtlanTags *[]AtlanTagName `json:"purposeAtlanTags,omitempty"`
}

PurposeAttributes represents the additional attributes for a Purpose asset.

type Query 

type Query struct {
	SQL
}

type ReRunRequest added in v0.0.16 

type ReRunRequest struct {
	Namespace    string `json:"namespace"`
	ResourceKind string `json:"resourceKind"`
	ResourceName string `json:"resourceName"`
}

ReRunRequest captures a request to rerun a workflow.

type Readme 

type Readme string

type Referenceable 

type Referenceable struct {
	// Type of the asset. For example Table, Column, and so on.
	TypeName *string `json:"typeName"`
	// Globally unique identifier (GUID) of any object in Atlan.
	Guid *string `json:"guid,omitempty"`
	// Atlan user who created this asset.
	CreatedBy *string `json:"createdBy,omitempty"`
	// Atlan user who last updated this asset.
	UpdatedBy *string `json:"updatedBy,omitempty"`
	// Asset status in Atlan (active vs deleted)
	Status *atlan.AtlanStatus `json:"status,omitempty"`
	// All directly-assigned Atlan tags that exist on an asset, searchable by internal hashed-string ID of the Atlan tag.
	AtlanTags *[]AtlanTag `json:"classifications,omitempty"`
	// All propagated Atlan tags that exist on an asset, searchable by internal hashed-string ID of the Atlan tag.
	PropagatedAtlanTags *string `json:"classifications,omitempty"`
	// All terms attached to an asset, searchable by the term's qualifiedName.
	AssignedTerms *[]AtlasGlossaryTerm `json:"meanings,omitempty"`
	// All super types of an asset.
	SuperTypeNames *string `json:"supertypeName,omitempty"`
	// Time (in milliseconds) when the asset was created.
	CreateTime *int `json:"createTime,omitempty"`
	// Time (in milliseconds) when the asset was last updated.
	UpdateTime *string `json:"updateTime,omitempty"`
	// Unique fully-qualified name of the asset in Atlan.
	QualifiedName *string `json:"qualifiedName,omitempty"`
}

type Relation 

type Relation struct {
	DisplayText        *string            `json:"displayText,omitempty"`
	EntityStatus       *string            `json:"entityStatus,omitempty"`
	RelationshipType   *string            `json:"relationshipType,omitempty"`
	RelationshipGuid   *string            `json:"relationshipGuid,omitempty"`
	RelationshipStatus *atlan.AtlanStatus `json:"relationshipStatus,omitempty"`
	// contains filtered or unexported fields
}

type RoleResponse added in v0.0.13 

type RoleResponse struct {
	// Total number of roles.
	TotalRecord *int `json:"total_record,omitempty"`
	// Number of roles in the filtered response.
	FilterRecord *int `json:"filter_record,omitempty" `
	// Details of each role included in the response.
	Records *[]AtlanRole `json:"records" `
}

RoleResponse represents the response containing a list of roles in Atlan.

type SQL 

type SQL struct {
	Catalog
	QueryCount            *int32            `json:"queryCount,omitempty"`
	QueryUserCount        *int32            `json:"queryUserCount,omitempty"`
	QueryUserMap          *map[string]int32 `json:"putQueryUserMap,omitempty"`
	QueryCountUpdatedAt   *int32            `json:"queryCountUpdatedAt,omitempty"`
	DatabaseName          *string           `json:"database,omitempty"`
	DatabaseQualifiedName *string           `json:"databaseQualifiedName,omitempty"`
	SchemaName            *string           `json:"schema,omitempty"`
	SchemaQualifiedName   *string           `json:"schemaQualifiedName,omitempty"`
	TableName             *string           `json:"tableName,omitempty"`
	TableQualifiedName    *string           `json:"tableQualifiedName,omitempty"`
	ViewName              *string           `json:"viewName,omitempty"`
	ViewQualifiedName     *string           `json:"viewQualifiedName,omitempty"`
	IsProfiled            *bool             `json:"isProfiled,omitempty"`
	LastProfiledAt        *int64            `json:"lastProfiledAt,omitempty"`
	DbtSources            *[]DbtSource      `json:"dbtSources,omitempty"`
	SqlDBTModels          *[]DbtModel       `json:"sqlDbtModels,omitempty"`
	SqlDBTSources         *[]DbtSource      `json:"sqlDbtSources,omitempty"`
	DbtModels             *[]DbtModel       `json:"dbtModels,omitempty"`
	DbtTests              *[]DbtTest        `json:"dbtTests,omitempty"`
}

type ScheduleQueriesSearchRequest added in v0.0.16 

type ScheduleQueriesSearchRequest struct {
	StartDate string `json:"startDate"`
	EndDate   string `json:"endDate"`
}

ScheduleQueriesSearchRequest defines a request for searching schedule queries.

type Schema 

type Schema struct {
	SQL
}

type SchemaRegistrySubject 

type SchemaRegistrySubject string

type SnowflakeDynamicTable 

type SnowflakeDynamicTable struct {
	Table
}

type SodaCheck 

type SodaCheck string

type SourceCostUnitType 

type SourceCostUnitType string

type StarredDetails 

type StarredDetails string

type Table 

type Table struct {
	SQL
	/** Alias for this table. */
	Alias *string `json:"alias,omitempty"`
	/** Number of columns in this table. */
	ColumnCount *int32 `json:"columnCount,omitempty"`
	/** Columns that exist within this table. */
	Columns                *[]Column          `json:"columns,omitempty"`
	Dimensions             *[]Table           `json:"dimensions,omitempty"`
	ExternalLocation       *string            `json:"externalLocation,omitempty"`
	ExternalLocationFormat *string            `json:"externalLocationFormat,omitempty"`
	ExternalLocationRegion *string            `json:"externalLocationRegion,omitempty"`
	Facts                  *[]Table           `json:"facts,omitempty"`
	IsPartitioned          *bool              `json:"isPartitioned,omitempty"`
	IsQueryPreview         *bool              `json:"isQueryPreview,omitempty"`
	IsTemporary            *bool              `json:"isTemporary,omitempty"`
	PartitionCount         *int32             `json:"partitionCount,omitempty"`
	PartitionList          *[]string          `json:"partitionList,omitempty"`
	PartitionStrategy      *string            `json:"partitionStrategy,omitempty"`
	Partitions             *[]TablePartition  `json:"partitions,omitempty"`
	Queries                *[]Query           `json:"queries,omitempty"`
	QueryPreviewConfig     *map[string]string `json:"putQueryPreviewConfig,omitempty"`
	RowCount               *int64             `json:"rowCount,omitempty"`
	Schema                 *Schema            `json:"atlanSchema,omitempty"`
	SizeBytes              *int64             `json:"sizeBytes,omitempty"`
}

type TablePartition 

type TablePartition struct {
	SQL
}

type UserAttributes added in v0.0.13 

type UserAttributes struct {
	// Designation for the user, such as an honorific or title.
	Designation *[]string `json:"designation,omitempty"`
	// Skills the user possesses.
	Skills *[]string `json:"skills,omitempty"`
	// Unique Slack member identifier.
	Slack *[]string `json:"slack,omitempty"`
	// Unique JIRA user identifier.
	Jira *[]string `json:"jira,omitempty"`
	// Time at which the user was invited (as a formatted string).
	InvitedAt *[]string `json:"invitedAt,omitempty"`
	// User who invited this user.
	InvitedBy *[]string `json:"invitedBy,omitempty"`
	ByName    *[]string `json:"invitedByName,omitempty"`
}

UserAttributes represents detailed attributes of an Atlan user.

type UserRequest added in v0.0.13 

type UserRequest struct {
	MaxLoginEvents int      `json:"maxLoginEvents,omitempty"` // Maximum login events to include
	PostFilter     *string  `json:"post_filter,omitempty"`    // Filter criteria for the user list
	Sort           *string  `json:"sort,omitempty"`           // Property to sort the list of users
	Count          bool     `json:"count"`                    // Whether to include a count of users
	Offset         int      `json:"offset,omitempty"`         // Starting point for paging
	Limit          int      `json:"limit,omitempty"`          // Maximum number of users per page
	Columns        []string `json:"columns,omitempty"`        // List of columns to be returned in the response
}

func (*UserRequest) QueryParams added in v0.0.13 

func (r *UserRequest) QueryParams() map[string]interface{}

QueryParams converts the UserRequest to a map of query parameters.

type UserStatus added in v0.0.13 

type UserStatus struct {
	Status        *int    // Response code for the association (200 is success).
	StatusMessage *string // Status message for the association ("success" means the association was successful).
}

UserStatus represents the status of a user association.

func (*UserStatus) WasSuccessful added in v0.0.13 

func (us *UserStatus) WasSuccessful() bool

WasSuccessful checks if the user association was successful.

type View 

type View struct {
	SQL
	ColumnCount        *int               `json:"columnCount,omitempty"`
	RowCount           *int               `json:"rowCount,omitempty"`
	SizeBytes          *int               `json:"sizeBytes,omitempty"`
	IsQueryPreview     *bool              `json:"isQueryPreview,omitempty"`
	QueryPreviewConfig *map[string]string `json:"queryPreviewConfig,omitempty"`
	Alias              *string            `json:"alias,omitempty"`
	IsTemporary        *bool              `json:"isTemporary,omitempty"`
	Definition         *string            `json:"definition,omitempty"`
	Columns            []*Column          `json:"columns,omitempty"`
	Queries            []*Query           `json:"queries,omitempty"`
	AtlanSchema        *Schema            `json:"atlanSchema,omitempty"`
}

type Workflow added in v0.0.16 

type Workflow struct {
	Metadata *WorkflowMetadata  `json:"metadata"`
	Spec     *WorkflowSpec      `json:"spec"`
	Payload  []PackageParameter `json:"payload,omitempty"`
}

Workflow represents the primary workflow object.

type WorkflowAsset added in v0.0.16 

type WorkflowAsset struct {
	Asset
	WorkflowAttributes *WorkflowAttributes `json:"Attributes"`
}

WorkflowAsset defines the Asset structure for a workflow.

type WorkflowAttributes added in v0.0.16 

type WorkflowAttributes struct {
	WorkflowTemplateGuid *string    `json:"workflowTemplateGuid,omitempty"`
	WorkflowType         *string    `json:"workflowType,omitempty"`
	WorkflowConfig       *string    `json:"workflowConfig,omitempty"`
	WorkflowStatus       *string    `json:"workflowStatus,omitempty"`
	WorkflowRunExpiresIn *string    `json:"workflowRunExpiresIn,omitempty"`
	WorkflowCreatedBy    *string    `json:"workflowCreatedBy,omitempty"`
	WorkflowUpdatedBy    *string    `json:"workflowUpdatedBy,omitempty"`
	WorkflowDeletedAt    *time.Time `json:"workflowDeletedAt,omitempty"`
}

WorkflowAttributes captures attributes of a workflow.

type WorkflowConfigMapKeyRef added in v0.0.16 

type WorkflowConfigMapKeyRef struct {
	Name string `json:"name"`
	Key  string `json:"key"`
}

WorkflowConfigMapKeyRef represents a reference to a ConfigMap key.

type WorkflowDAG added in v0.0.16 

type WorkflowDAG struct {
	Tasks []WorkflowTask `json:"tasks"`
}

WorkflowDAG represents a directed acyclic graph (DAG) of workflow tasks.

type WorkflowMetadata added in v0.0.16 

type WorkflowMetadata struct {
	Annotations       map[string]string `json:"annotations,omitempty"`
	CreationTimestamp *string           `json:"creationTimestamp,omitempty"`
	GenerateName      *string           `json:"generateName,omitempty"`
	Generation        *int              `json:"generation,omitempty"`
	Labels            map[string]string `json:"labels,omitempty"`
	ManagedFields     []interface{}     `json:"managedFields,omitempty"`
	Name              *string           `json:"name,omitempty"`
	Namespace         *string           `json:"namespace,omitempty"`
	ResourceVersion   *string           `json:"resourceVersion,omitempty"`
	UID               *string           `json:"uid,omitempty"`
}

WorkflowMetadata captures metadata about a workflow.

type WorkflowParameters added in v0.0.16 

type WorkflowParameters struct {
	Parameters []NameValuePair `json:"parameters"`
}

WorkflowParameters holds parameters for workflow operations.

type WorkflowResponse added in v0.0.16 

type WorkflowResponse struct {
	Metadata *WorkflowMetadata `json:"metadata"`
	Spec     *WorkflowSpec     `json:"spec"`
	Payload  []interface{}     `json:"payload,omitempty"`
}

WorkflowResponse represents a generic workflow response.

type WorkflowRun added in v0.0.16 

type WorkflowRun struct {
	Asset
	WorkflowRunAttributes *WorkflowRunAttributes `json:"Attributes"`
}

WorkflowRun defines a workflow run as an Asset.

type WorkflowRunAttributes added in v0.0.16 

type WorkflowRunAttributes struct {
	WorkflowRunGuid        *string `json:"workflowRunGuid,omitempty"`
	WorkflowRunType        *string `json:"workflowRunType,omitempty"`
	WorkflowRunOnAssetGuid *string `json:"workflowRunOnAssetGuid,omitempty"`
	WorkflowRunComment     *string `json:"workflowRunComment,omitempty"`
	WorkflowRunConfig      *string `json:"workflowRunConfig,omitempty"`
	WorkflowRunStatus      *string `json:"workflowRunStatus,omitempty"`
	WorkflowRunExpiresAt   *string `json:"workflowRunExpiresAt,omitempty"`
	WorkflowRunCreatedBy   *string `json:"workflowRunCreatedBy,omitempty"`
	WorkflowRunUpdatedBy   *string `json:"workflowRunUpdatedBy,omitempty"`
	WorkflowRunDeletedAt   *string `json:"workflowRunDeletedAt,omitempty"`
}

type WorkflowRunResponse added in v0.0.16 

type WorkflowRunResponse struct {
	WorkflowResponse
	Status WorkflowSearchResultStatus `json:"status"`
}

WorkflowRunResponse extends WorkflowResponse with status information.

type WorkflowSchedule added in v0.0.16 

type WorkflowSchedule struct {
	Timezone     string `json:"timezone"`
	CronSchedule string `json:"cronSchedule"`
}

WorkflowSchedule defines a workflow schedule.

type WorkflowScheduleResponse added in v0.0.16 

type WorkflowScheduleResponse struct {
	Metadata         *WorkflowMetadata       `json:"metadata,omitempty"`
	Spec             *WorkflowScheduleSpec   `json:"spec,omitempty"`
	Status           *WorkflowScheduleStatus `json:"status,omitempty"`
	WorkflowMetadata *WorkflowMetadata       `json:"workflowMetadata,omitempty"`
}

WorkflowScheduleResponse captures the response for a workflow schedule.

type WorkflowScheduleSpec added in v0.0.16 

type WorkflowScheduleSpec struct {
	Schedule                   *string       `json:"schedule,omitempty"`
	Timezone                   *string       `json:"timezone,omitempty"`
	WorkflowSpec               *WorkflowSpec `json:"workflowSpec,omitempty"`
	ConcurrencyPolicy          *string       `json:"concurrencyPolicy,omitempty"`
	StartingDeadlineSeconds    *int          `json:"startingDeadlineSeconds,omitempty"`
	SuccessfulJobsHistoryLimit *int          `json:"successfulJobsHistoryLimit,omitempty"`
	FailedJobsHistoryLimit     *int          `json:"failedJobsHistoryLimit,omitempty"`
}

WorkflowScheduleSpec specifies details for a workflow schedule.

type WorkflowScheduleStatus added in v0.0.16 

type WorkflowScheduleStatus struct {
	Active            interface{} `json:"active,omitempty"`
	Conditions        interface{} `json:"conditions,omitempty"`
	LastScheduledTime *string     `json:"lastScheduledTime,omitempty"`
}

WorkflowScheduleStatus captures the status of a workflow schedule.

type WorkflowSearchHits added in v0.0.16 

type WorkflowSearchHits struct {
	Total map[string]interface{} `json:"total"`
	Hits  []WorkflowSearchResult `json:"hits,omitempty"`
}

WorkflowSearchHits contains hits from a workflow search response.

type WorkflowSearchResponse added in v0.0.16 

type WorkflowSearchResponse struct {
	Took   *int                   `json:"took,omitempty"`
	Hits   WorkflowSearchHits     `json:"hits"`
	Shards map[string]interface{} `json:"_shards"`
}

WorkflowSearchResponse represents the response from a workflow search.

type WorkflowSearchResult added in v0.0.16 

type WorkflowSearchResult struct {
	Index       string                     `json:"_index"`
	Type        string                     `json:"_type"`
	ID          string                     `json:"_id"`
	SeqNo       interface{}                `json:"_seq_no"`
	PrimaryTerm interface{}                `json:"_primary_term"`
	Sort        []interface{}              `json:"sort"`
	Source      WorkflowSearchResultDetail `json:"_source"`
}

WorkflowSearchResult captures the search result for a workflow.

func (*WorkflowSearchResult) Status added in v0.0.16 

func (w *WorkflowSearchResult) Status() *atlan.AtlanWorkflowPhase

Status returns the workflow phase if available.

func (*WorkflowSearchResult) ToWorkflow added in v0.0.16 

func (w *WorkflowSearchResult) ToWorkflow() *Workflow

ToWorkflow converts a WorkflowSearchResult into a Workflow object.

type WorkflowSearchResultDetail added in v0.0.16 

type WorkflowSearchResultDetail struct {
	APIVersion string                      `json:"apiVersion"`
	Kind       string                      `json:"kind"`
	Metadata   WorkflowMetadata            `json:"metadata"`
	Spec       WorkflowSpec                `json:"spec"`
	Status     *WorkflowSearchResultStatus `json:"status,omitempty"`
}

WorkflowSearchResultDetail contains detailed information about a workflow search result.

type WorkflowSearchResultStatus added in v0.0.16 

type WorkflowSearchResultStatus struct {
	ArtifactGCStatus           map[string]interface{}    `json:"artifactGCStatus,omitempty"`
	ArtifactRepositoryRef      interface{}               `json:"artifactRepositoryRef,omitempty"`
	CompressedNodes            *string                   `json:"compressedNodes,omitempty"`
	EstimatedDuration          *int                      `json:"estimatedDuration,omitempty"`
	Conditions                 []interface{}             `json:"conditions,omitempty"`
	Message                    *string                   `json:"message,omitempty"`
	FinishedAt                 *string                   `json:"finishedAt,omitempty"`
	Nodes                      interface{}               `json:"nodes,omitempty"`
	Outputs                    *WorkflowParameters       `json:"outputs,omitempty"`
	Phase                      *atlan.AtlanWorkflowPhase `json:"phase,omitempty"`
	Progress                   *string                   `json:"progress,omitempty"`
	ResourcesDuration          map[string]int            `json:"resourcesDuration,omitempty"`
	StartedAt                  *string                   `json:"startedAt,omitempty"`
	StoredTemplates            interface{}               `json:"storedTemplates,omitempty"`
	StoredWorkflowTemplateSpec interface{}               `json:"storedWorkflowTemplateSpec,omitempty"`
	Synchronization            map[string]interface{}    `json:"synchronization,omitempty"`
}

WorkflowSearchResultStatus captures the status of a workflow search result.

type WorkflowSemaphore added in v0.0.16 

type WorkflowSemaphore struct {
	ConfigMapKeyRef *WorkflowConfigMapKeyRef `json:"configMapKeyRef,omitempty"`
}

WorkflowSemaphore represents a semaphore for workflow concurrency control.

type WorkflowSpec added in v0.0.16 

type WorkflowSpec struct {
	Entrypoint          *string                  `json:"entrypoint,omitempty"`
	Arguments           interface{}              `json:"arguments,omitempty"`
	Templates           []WorkflowTemplate       `json:"templates,omitempty"`
	WorkflowTemplateRef map[string]string        `json:"workflowTemplateRef,omitempty"`
	WorkflowMetadata    *WorkflowMetadata        `json:"workflowMetadata,omitempty"`
	Synchronization     *WorkflowSynchronization `json:"synchronization,omitempty"`
}

WorkflowSpec defines the specification of a workflow.

type WorkflowSynchronization added in v0.0.16 

type WorkflowSynchronization struct {
	Semaphore *WorkflowSemaphore `json:"semaphore,omitempty"`
}

WorkflowSynchronization represents the synchronization settings for a workflow.

type WorkflowTask added in v0.0.16 

type WorkflowTask struct {
	Name        string              `json:"name"`
	Arguments   WorkflowParameters  `json:"arguments"`
	TemplateRef WorkflowTemplateRef `json:"templateRef"`
}

WorkflowTask represents a task in the workflow.

type WorkflowTemplate added in v0.0.16 

type WorkflowTemplate struct {
	Name     string      `json:"name"`
	Inputs   interface{} `json:"inputs,omitempty"`
	Outputs  interface{} `json:"outputs,omitempty"`
	Metadata interface{} `json:"metadata,omitempty"`
	DAG      WorkflowDAG `json:"dag"`
}

WorkflowTemplate captures the structure of a workflow template.

type WorkflowTemplateRef added in v0.0.16 

type WorkflowTemplateRef struct {
	Name         string `json:"name"`
	Template     string `json:"template"`
	ClusterScope bool   `json:"clusterScope"`
}

WorkflowTemplateRef references a specific workflow template.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.