Class Entity
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Entity.Builder,Entity>
An entity supported by a given ConnectionType.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Entity.Builderbuilder()final Stringcategory()The type of entities that are present in the response.An optional map of keys which may be returned for an entity by a connector.final StringA description of the entity.final StringThe name of the entity.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the CustomProperties property.final inthashCode()final BooleanA Boolean value which helps to determine whether there are sub objects that can be listed.final Stringlabel()Label used for the entity.static Class<? extends Entity.Builder>final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
entityName
The name of the entity.
- Returns:
- The name of the entity.
-
label
Label used for the entity.
- Returns:
- Label used for the entity.
-
isParentEntity
A Boolean value which helps to determine whether there are sub objects that can be listed.
- Returns:
- A Boolean value which helps to determine whether there are sub objects that can be listed.
-
description
A description of the entity.
- Returns:
- A description of the entity.
-
category
The type of entities that are present in the response. This value depends on the source connection. For example this is
SObjectsfor Salesforce anddatabasesorschemasortablesfor sources like Amazon Redshift.- Returns:
- The type of entities that are present in the response. This value depends on the source connection. For
example this is
SObjectsfor Salesforce anddatabasesorschemasortablesfor sources like Amazon Redshift.
-
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
An optional map of keys which may be returned for an entity by a connector.
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:
- An optional map of keys which may be returned for an entity by a connector.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<Entity.Builder,Entity>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-