Skip to content

/AWS1/CL_GLUFIELDDEFINITION

Defines a field in an entity schema for REST connector data sources, specifying the field name and data type.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/GLUSTRING /AWS1/GLUSTRING

The name of the field in the entity schema.

iv_fielddatatype TYPE /AWS1/GLUFIELDDATATYPE /AWS1/GLUFIELDDATATYPE

The data type of the field.

Optional arguments:

iv_responsedateformat TYPE /AWS1/GLUSTRING /AWS1/GLUSTRING

The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds.

iv_ispartitionable TYPE /AWS1/GLUBOOL /AWS1/GLUBOOL

Indicates whether this field can be used for partitioning queries to the data source.

iv_isnullable TYPE /AWS1/GLUBOOL /AWS1/GLUBOOL

Indicates whether this field can contain null values.

iv_isqueryable TYPE /AWS1/GLUBOOL /AWS1/GLUBOOL

Indicates whether this field can be used in filter predicates when querying data.

iv_isorderable TYPE /AWS1/GLUBOOL /AWS1/GLUBOOL

Indicates whether this field can be used for ordering results.

io_filteroverrides TYPE REF TO /AWS1/CL_GLUFILTEROVERRIDES /AWS1/CL_GLUFILTEROVERRIDES

Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.


Queryable Attributes

Name

The name of the field in the entity schema.

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

FieldDataType

The data type of the field.

Accessible with the following methods

Method Description
GET_FIELDDATATYPE() Getter for FIELDDATATYPE, with configurable default
ASK_FIELDDATATYPE() Getter for FIELDDATATYPE w/ exceptions if field has no value
HAS_FIELDDATATYPE() Determine if FIELDDATATYPE has a value

ResponseDateFormat

The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds.

Accessible with the following methods

Method Description
GET_RESPONSEDATEFORMAT() Getter for RESPONSEDATEFORMAT, with configurable default
ASK_RESPONSEDATEFORMAT() Getter for RESPONSEDATEFORMAT w/ exceptions if field has no
HAS_RESPONSEDATEFORMAT() Determine if RESPONSEDATEFORMAT has a value

IsPartitionable

Indicates whether this field can be used for partitioning queries to the data source.

Accessible with the following methods

Method Description
GET_ISPARTITIONABLE() Getter for ISPARTITIONABLE, with configurable default
ASK_ISPARTITIONABLE() Getter for ISPARTITIONABLE w/ exceptions if field has no val
HAS_ISPARTITIONABLE() Determine if ISPARTITIONABLE has a value

IsNullable

Indicates whether this field can contain null values.

Accessible with the following methods

Method Description
GET_ISNULLABLE() Getter for ISNULLABLE, with configurable default
ASK_ISNULLABLE() Getter for ISNULLABLE w/ exceptions if field has no value
HAS_ISNULLABLE() Determine if ISNULLABLE has a value

IsQueryable

Indicates whether this field can be used in filter predicates when querying data.

Accessible with the following methods

Method Description
GET_ISQUERYABLE() Getter for ISQUERYABLE, with configurable default
ASK_ISQUERYABLE() Getter for ISQUERYABLE w/ exceptions if field has no value
HAS_ISQUERYABLE() Determine if ISQUERYABLE has a value

IsOrderable

Indicates whether this field can be used for ordering results.

Accessible with the following methods

Method Description
GET_ISORDERABLE() Getter for ISORDERABLE, with configurable default
ASK_ISORDERABLE() Getter for ISORDERABLE w/ exceptions if field has no value
HAS_ISORDERABLE() Determine if ISORDERABLE has a value

FilterOverrides

Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.

Accessible with the following methods

Method Description
GET_FILTEROVERRIDES() Getter for FILTEROVERRIDES

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_FIELDDEFINITIONMAP

TYPES TT_FIELDDEFINITIONMAP TYPE HASHED TABLE OF /AWS1/CL_GLUFIELDDEFINITION=>TS_FIELDDEFINITIONMAP_MAPROW WITH UNIQUE KEY key
.

TS_FIELDDEFINITIONMAP_MAPROW

TYPES: BEGIN OF TS_FIELDDEFINITIONMAP_MAPROW,
  key TYPE /AWS1/GLUFIELDDEFNMAPKEYSTRING,
  value TYPE REF TO /AWS1/CL_GLUFIELDDEFINITION,
END OF TS_FIELDDEFINITIONMAP_MAPROW.