com.amazonaws.appflow.custom.connector.model.metadata

Class ImmutableEntityDefinition

java.lang.Object

com.amazonaws.appflow.custom.connector.model.metadata.ImmutableEntityDefinition

All Implemented Interfaces:

EntityDefinition

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
public final class ImmutableEntityDefinition
extends Object
implements EntityDefinition

Immutable implementation of EntityDefinition.

Use the builder to create immutable instances: ImmutableEntityDefinition.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableEntityDefinition.Builder Builds instances of type ImmutableEntityDefinition.

Method Summary

Modifier and Type	Method and Description
static ImmutableEntityDefinition.Builder	builder() Creates a builder for ImmutableEntityDefinition.
static ImmutableEntityDefinition	copyOf(EntityDefinition instance) Creates an immutable copy of a EntityDefinition value.
com.google.common.collect.ImmutableMap<String,String>	customProperties() Custom properties defined for an Entity.
Entity	entity() Contains its name, description, label or if it has child properties or not.
boolean	equals(Object another) This instance is equal to all instances of ImmutableEntityDefinition that have equal attribute values.
com.google.common.collect.ImmutableList<FieldDefinition>	fields() List of data models of the fields an Entity has.
int	hashCode() Computes a hash code from attributes: entity, fields, customProperties.
String	toString() Prints the immutable value EntityDefinition with attribute values.
ImmutableEntityDefinition	withCustomProperties(Map<String,? extends String> entries) Copy the current immutable object by replacing the customProperties map with the specified map.
ImmutableEntityDefinition	withEntity(Entity value) Copy the current immutable object by setting a value for the entity attribute.
ImmutableEntityDefinition	withFields(FieldDefinition... elements) Copy the current immutable object with elements that replace the content of fields.
ImmutableEntityDefinition	withFields(Iterable<? extends FieldDefinition> elements) Copy the current immutable object with elements that replace the content of fields.

Methods inherited from class java.lang.Object

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

Method Detail

entity

public Entity entity()

Contains its name, description, label or if it has child properties or not.

Specified by:

entity in interface EntityDefinition

fields

public com.google.common.collect.ImmutableList<FieldDefinition> fields()

List of data models of the fields an Entity has.

Specified by:

fields in interface EntityDefinition

customProperties

@Nullable
public com.google.common.collect.ImmutableMap<String,String> customProperties()

Custom properties defined for an Entity.

Specified by:

customProperties in interface EntityDefinition

withEntity

public final ImmutableEntityDefinition withEntity(Entity value)

Copy the current immutable object by setting a value for the entity attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for entity

Returns:

A modified copy of the this object

withFields

public final ImmutableEntityDefinition withFields(FieldDefinition... elements)

Copy the current immutable object with elements that replace the content of fields.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withFields

public final ImmutableEntityDefinition withFields(Iterable<? extends FieldDefinition> elements)

Copy the current immutable object with elements that replace the content of fields. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of fields elements to set

Returns:

A modified copy of this object

withCustomProperties

public final ImmutableEntityDefinition withCustomProperties(@Nullable
                                                            Map<String,? extends String> entries)

Copy the current immutable object by replacing the customProperties map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the customProperties map

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableEntityDefinition that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: entity, fields, customProperties.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value EntityDefinition with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableEntityDefinition copyOf(EntityDefinition instance)

Creates an immutable copy of a EntityDefinition value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable EntityDefinition instance

builder

public static ImmutableEntityDefinition.Builder builder()

Creates a builder for ImmutableEntityDefinition.

 ImmutableEntityDefinition.builder()
    .entity(com.amazonaws.appflow.custom.connector.model.metadata.Entity) // required entity
    .addFields|addAllFields(com.amazonaws.appflow.custom.connector.model.metadata.FieldDefinition) // fields elements
    .customProperties(Map<String, String> | null) // nullable customProperties
    .build();
 

Returns:

A new ImmutableEntityDefinition builder