Package software.amazon.awssdk.services.glue.model

Class Entity

java.lang.Object

software.amazon.awssdk.services.glue.model.Entity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Entity.Builder,Entity>

@Generated("software.amazon.awssdk:codegen")
public final class Entity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Entity.Builder,Entity>

An entity supported by a given ConnectionType.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Entity.Builder

Method Summary

Modifier and Type	Method	Description
static Entity.Builder	builder()
String	category()	The type of entities that are present in the response.
Map<String,String>	customProperties()	An optional map of keys which may be returned for an entity by a connector.
String	description()	A description of the entity.
String	entityName()	The name of the entity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCustomProperties()	For responses, this returns true if the service returned a value for the CustomProperties property.
int	hashCode()
Boolean	isParentEntity()	A Boolean value which helps to determine whether there are sub objects that can be listed.
String	label()	Label used for the entity.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Entity.Builder>	serializableBuilderClass()
Entity.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

entityName

public final String entityName()

The name of the entity.

Returns:

The name of the entity.

label

public final String label()

Label used for the entity.

Returns:

Label used for the entity.

isParentEntity

public final Boolean 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

public final String description()

A description of the entity.

Returns:

A description of the entity.

category

public final String category()

The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for 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 SObjects for Salesforce and databases or schemas or tables for 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 the isEmpty() 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

public final Map<String,String> 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

public Entity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Entity.Builder,Entity>

builder

public static Entity.Builder builder()

serializableBuilderClass

public static Class<? extends Entity.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo