/AWS1/CL_CRMSCHEMA¶
A schema is a relation within a collaboration.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
it_columns TYPE /AWS1/CL_CRMCOLUMN=>TT_COLUMNLIST TT_COLUMNLIST¶
The columns for the relation that this schema represents.
it_partitionkeys TYPE /AWS1/CL_CRMCOLUMN=>TT_COLUMNLIST TT_COLUMNLIST¶
The partition keys for the dataset underlying this schema.
it_analysisruletypes TYPE /AWS1/CL_CRMALYRULETYPELIST_W=>TT_ANALYSISRULETYPELIST TT_ANALYSISRULETYPELIST¶
The analysis rule types that are associated with the schema. Currently, only one entry is present.
iv_creatoraccountid TYPE /AWS1/CRMACCOUNTID /AWS1/CRMACCOUNTID¶
The unique account ID for the Amazon Web Services account that owns the schema.
iv_name TYPE /AWS1/CRMTABLEALIAS /AWS1/CRMTABLEALIAS¶
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
iv_collaborationid TYPE /AWS1/CRMUUID /AWS1/CRMUUID¶
The unique ID for the collaboration that the schema belongs to.
iv_collaborationarn TYPE /AWS1/CRMCOLLABORATIONARN /AWS1/CRMCOLLABORATIONARN¶
The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
iv_description TYPE /AWS1/CRMTABLEDESCRIPTION /AWS1/CRMTABLEDESCRIPTION¶
A description for the schema.
iv_createtime TYPE /AWS1/CRMTIMESTAMP /AWS1/CRMTIMESTAMP¶
The time at which the schema was created.
iv_updatetime TYPE /AWS1/CRMTIMESTAMP /AWS1/CRMTIMESTAMP¶
The most recent time at which the schema was updated.
iv_type TYPE /AWS1/CRMSCHEMATYPE /AWS1/CRMSCHEMATYPE¶
The type of schema.
it_schemastatusdetails TYPE /AWS1/CL_CRMSCHEMASTATUSDETAIL=>TT_SCHEMASTATUSDETAILLIST TT_SCHEMASTATUSDETAILLIST¶
Details about the status of the schema. Currently, only one entry is present.
Optional arguments:¶
iv_analysismethod TYPE /AWS1/CRMANALYSISMETHOD /AWS1/CRMANALYSISMETHOD¶
The analysis method for the schema.
DIRECT_QUERYallows SQL queries to be run directly on this table.
DIRECT_JOBallows PySpark jobs to be run directly on this table.
MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.
it_selectedanalysismethods TYPE /AWS1/CL_CRMSELEDALYMETHODS_W=>TT_SELECTEDANALYSISMETHODS TT_SELECTEDANALYSISMETHODS¶
The selected analysis methods for the schema.
iv_resourcearn TYPE /AWS1/CRMSCHEMARESOURCEARN /AWS1/CRMSCHEMARESOURCEARN¶
The Amazon Resource Name (ARN) of the schema resource.
io_schematypeproperties TYPE REF TO /AWS1/CL_CRMSCHEMATYPEPRPS /AWS1/CL_CRMSCHEMATYPEPRPS¶
The schema type properties.
Queryable Attributes¶
columns¶
The columns for the relation that this schema represents.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COLUMNS() |
Getter for COLUMNS, with configurable default |
ASK_COLUMNS() |
Getter for COLUMNS w/ exceptions if field has no value |
HAS_COLUMNS() |
Determine if COLUMNS has a value |
partitionKeys¶
The partition keys for the dataset underlying this schema.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARTITIONKEYS() |
Getter for PARTITIONKEYS, with configurable default |
ASK_PARTITIONKEYS() |
Getter for PARTITIONKEYS w/ exceptions if field has no value |
HAS_PARTITIONKEYS() |
Determine if PARTITIONKEYS has a value |
analysisRuleTypes¶
The analysis rule types that are associated with the schema. Currently, only one entry is present.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ANALYSISRULETYPES() |
Getter for ANALYSISRULETYPES, with configurable default |
ASK_ANALYSISRULETYPES() |
Getter for ANALYSISRULETYPES w/ exceptions if field has no v |
HAS_ANALYSISRULETYPES() |
Determine if ANALYSISRULETYPES has a value |
analysisMethod¶
The analysis method for the schema.
DIRECT_QUERYallows SQL queries to be run directly on this table.
DIRECT_JOBallows PySpark jobs to be run directly on this table.
MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ANALYSISMETHOD() |
Getter for ANALYSISMETHOD, with configurable default |
ASK_ANALYSISMETHOD() |
Getter for ANALYSISMETHOD w/ exceptions if field has no valu |
HAS_ANALYSISMETHOD() |
Determine if ANALYSISMETHOD has a value |
selectedAnalysisMethods¶
The selected analysis methods for the schema.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SELECTEDANALYSISMETHODS() |
Getter for SELECTEDANALYSISMETHODS, with configurable defaul |
ASK_SELECTEDANALYSISMETHODS() |
Getter for SELECTEDANALYSISMETHODS w/ exceptions if field ha |
HAS_SELECTEDANALYSISMETHODS() |
Determine if SELECTEDANALYSISMETHODS has a value |
creatorAccountId¶
The unique account ID for the Amazon Web Services account that owns the schema.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATORACCOUNTID() |
Getter for CREATORACCOUNTID, with configurable default |
ASK_CREATORACCOUNTID() |
Getter for CREATORACCOUNTID w/ exceptions if field has no va |
HAS_CREATORACCOUNTID() |
Determine if CREATORACCOUNTID has a value |
name¶
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
collaborationId¶
The unique ID for the collaboration that the schema belongs to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COLLABORATIONID() |
Getter for COLLABORATIONID, with configurable default |
ASK_COLLABORATIONID() |
Getter for COLLABORATIONID w/ exceptions if field has no val |
HAS_COLLABORATIONID() |
Determine if COLLABORATIONID has a value |
collaborationArn¶
The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COLLABORATIONARN() |
Getter for COLLABORATIONARN, with configurable default |
ASK_COLLABORATIONARN() |
Getter for COLLABORATIONARN w/ exceptions if field has no va |
HAS_COLLABORATIONARN() |
Determine if COLLABORATIONARN has a value |
description¶
A description for the schema.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
createTime¶
The time at which the schema was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATETIME() |
Getter for CREATETIME, with configurable default |
ASK_CREATETIME() |
Getter for CREATETIME w/ exceptions if field has no value |
HAS_CREATETIME() |
Determine if CREATETIME has a value |
updateTime¶
The most recent time at which the schema was updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATETIME() |
Getter for UPDATETIME, with configurable default |
ASK_UPDATETIME() |
Getter for UPDATETIME w/ exceptions if field has no value |
HAS_UPDATETIME() |
Determine if UPDATETIME has a value |
type¶
The type of schema.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
schemaStatusDetails¶
Details about the status of the schema. Currently, only one entry is present.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEMASTATUSDETAILS() |
Getter for SCHEMASTATUSDETAILS, with configurable default |
ASK_SCHEMASTATUSDETAILS() |
Getter for SCHEMASTATUSDETAILS w/ exceptions if field has no |
HAS_SCHEMASTATUSDETAILS() |
Determine if SCHEMASTATUSDETAILS has a value |
resourceArn¶
The Amazon Resource Name (ARN) of the schema resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEARN() |
Getter for RESOURCEARN, with configurable default |
ASK_RESOURCEARN() |
Getter for RESOURCEARN w/ exceptions if field has no value |
HAS_RESOURCEARN() |
Determine if RESOURCEARN has a value |
schemaTypeProperties¶
The schema type properties.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEMATYPEPROPERTIES() |
Getter for SCHEMATYPEPROPERTIES |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SCHEMALIST¶
TYPES TT_SCHEMALIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CRMSCHEMA WITH DEFAULT KEY
.