Field

class Field

The Field object has information about the different properties associated with a field in the connector.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Optional map of keys which may be returned.

Link copied to clipboard

A description of the field.

Link copied to clipboard

A unique identifier for the field.

Link copied to clipboard

The type of data in the field.

Link copied to clipboard

Indicates whether this field can be created as part of a destination write.

Link copied to clipboard

Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.

Link copied to clipboard

Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.

Link copied to clipboard

Indicates whether this field can be nullable or not.

Link copied to clipboard

Indicates whether a given field can be used in partitioning the query made to SaaS.

Link copied to clipboard

Indicates whether this field can used as a primary key for the given entity.

Link copied to clipboard

Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.

Link copied to clipboard

Indicates whether this field can be updated as part of a destination write.

Link copied to clipboard

Indicates whether this field can be upserted as part of a destination write.

Link copied to clipboard

A readable label used for the field.

Link copied to clipboard

The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.

Link copied to clipboard

A parent field name for a nested field.

Link copied to clipboard

Indicates the support filter operators for this field.

Link copied to clipboard

A list of supported values for the field.

Functions

Link copied to clipboard
inline fun copy(block: Field.Builder.() -> Unit = {}): Field
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String