Class ConnectorEntityField
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ConnectorEntityField.Builder,
ConnectorEntityField>
Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ConnectorEntityField.Builder
builder()
A map that has specific properties related to the ConnectorEntityField.final String
Default value that can be assigned to this field.final String
A description of the connector entity field.The properties applied to a field when the connector is being used as a destination.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CustomProperties property.final int
hashCode()
final String
The unique identifier of the connector field.final Boolean
Booelan value that indicates whether this field is deprecated or not.final Boolean
Booelan value that indicates whether this field can be used as a primary key.final String
label()
The label applied to a connector entity field.final String
The parent identifier of the connector field.static Class
<? extends ConnectorEntityField.Builder> final SourceFieldProperties
The properties that can be applied to a field when the connector is being used as a source.Contains details regarding the supportedFieldType
, including the correspondingfilterOperators
andsupportedValues
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
identifier
The unique identifier of the connector field.
- Returns:
- The unique identifier of the connector field.
-
parentIdentifier
The parent identifier of the connector field.
- Returns:
- The parent identifier of the connector field.
-
label
The label applied to a connector entity field.
- Returns:
- The label applied to a connector entity field.
-
isPrimaryKey
Booelan value that indicates whether this field can be used as a primary key.
- Returns:
- Booelan value that indicates whether this field can be used as a primary key.
-
defaultValue
Default value that can be assigned to this field.
- Returns:
- Default value that can be assigned to this field.
-
isDeprecated
Booelan value that indicates whether this field is deprecated or not.
- Returns:
- Booelan value that indicates whether this field is deprecated or not.
-
supportedFieldTypeDetails
Contains details regarding the supported
FieldType
, including the correspondingfilterOperators
andsupportedValues
.- Returns:
- Contains details regarding the supported
FieldType
, including the correspondingfilterOperators
andsupportedValues
.
-
description
A description of the connector entity field.
- Returns:
- A description of the connector entity field.
-
sourceProperties
The properties that can be applied to a field when the connector is being used as a source.
- Returns:
- The properties that can be applied to a field when the connector is being used as a source.
-
destinationProperties
The properties applied to a field when the connector is being used as a destination.
- Returns:
- The properties applied to a field when the connector is being used as a destination.
-
hasCustomProperties
public final boolean hasCustomProperties()For responses, this returns true if the service returned a value for the CustomProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
customProperties
A map that has specific properties related to the ConnectorEntityField.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCustomProperties()
method.- Returns:
- A map that has specific properties related to the ConnectorEntityField.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ConnectorEntityField.Builder,
ConnectorEntityField> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-