Mode¶
Base class for Mode assets.
Reference documentation
This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand managing Mode assets in Atlan. For that, we would suggest starting with either:
classDiagram
direction RL
class Mode {
<<abstract>>
}
link Mode "../mode"
class BI {
<<abstract>>
}
link BI "../entities/bi"
BI <|-- Mode : extends
class Catalog {
<<abstract>>
}
link Catalog "../entities/catalog"
Catalog <|-- BI : extends
class Asset {
<<abstract>>
}
link Asset "../entities/asset"
Asset <|-- Catalog : extends
class Referenceable {
<<abstract>>
}
link Referenceable "../entities/referenceable"
Referenceable <|-- Asset : extends
class ModeReport
link ModeReport "../entities/modereport"
Mode <|-- ModeReport : extends
class ModeQuery
link ModeQuery "../entities/modequery"
Mode <|-- ModeQuery : extends
class ModeChart
link ModeChart "../entities/modechart"
Mode <|-- ModeChart : extends
class ModeWorkspace
link ModeWorkspace "../entities/modeworkspace"
Mode <|-- ModeWorkspace : extends
class ModeCollection
link ModeCollection "../entities/modecollection"
Mode <|-- ModeCollection : extends
Type-specific properties¶
Following are the properties uniquely available on Mode
assets in Atlan.
modeId
TBC | |
---|---|
1 2 3 |
|
-
Set the
modeId
for aMode
. -
Retrieve the
modeId
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeId
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
modeQueryName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeQueryName
for aMode
. -
Retrieve the
modeQueryName
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeQueryName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeQueryName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeQueryQualifiedName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeQueryQualifiedName
for aMode
. -
Retrieve the
modeQueryQualifiedName
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeQueryQualifiedName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeQueryQualifiedName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeReportName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeReportName
for aMode
. -
Retrieve the
modeReportName
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeReportName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeReportName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeReportQualifiedName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeReportQualifiedName
for aMode
. -
Retrieve the
modeReportQualifiedName
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeReportQualifiedName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeReportQualifiedName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeToken
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeToken
for aMode
. -
Retrieve the
modeToken
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeToken
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeToken
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeWorkspaceName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeWorkspaceName
for aMode
. -
Retrieve the
modeWorkspaceName
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeWorkspaceName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeWorkspaceName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeWorkspaceQualifiedName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeWorkspaceQualifiedName
for aMode
. -
Retrieve the
modeWorkspaceQualifiedName
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeWorkspaceQualifiedName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeWorkspaceQualifiedName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeWorkspaceUsername
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
modeWorkspaceUsername
for aMode
. -
Retrieve the
modeWorkspaceUsername
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
modeWorkspaceUsername
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
modeWorkspaceUsername
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
mode_id
for aMode
. -
Retrieve the
mode_id
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_id
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
mode_query_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_query_name
for aMode
. -
Retrieve the
mode_query_name
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_query_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_query_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_query_qualified_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_query_qualified_name
for aMode
. -
Retrieve the
mode_query_qualified_name
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_query_qualified_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_query_qualified_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_report_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_report_name
for aMode
. -
Retrieve the
mode_report_name
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_report_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_report_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_report_qualified_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_report_qualified_name
for aMode
. -
Retrieve the
mode_report_qualified_name
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_report_qualified_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_report_qualified_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_token
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_token
for aMode
. -
Retrieve the
mode_token
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_token
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_token
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_workspace_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_workspace_name
for aMode
. -
Retrieve the
mode_workspace_name
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_workspace_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_workspace_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_workspace_qualified_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_workspace_qualified_name
for aMode
. -
Retrieve the
mode_workspace_qualified_name
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_workspace_qualified_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_workspace_qualified_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
mode_workspace_username
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
mode_workspace_username
for aMode
. -
Retrieve the
mode_workspace_username
from aMode
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
mode_workspace_username
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
mode_workspace_username
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
modeId
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeId
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeQueryName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeQueryName
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeQueryQualifiedName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeQueryQualifiedName
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeReportName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeReportName
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeReportQualifiedName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeReportQualifiedName
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeToken
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeToken
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeWorkspaceName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeWorkspaceName
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeWorkspaceQualifiedName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeWorkspaceQualifiedName
for aMode
.For more details
For more information, see the asset CRUD snippets.
modeWorkspaceUsername
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
modeWorkspaceUsername
for aMode
.For more details
For more information, see the asset CRUD snippets.
Relationships¶
The following illustrates how the various Mode objects inter-relate with each other:
erDiagram
Connection ||..o{ ModeWorkspace : ""
ModeWorkspace |o--o{ ModeCollection : modeCollections
ModeCollection }o--o{ ModeReport : modeReports
ModeReport |o--o{ ModeQuery : modeQueries
ModeQuery |o--o{ ModeChart : modeCharts