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

Class ImmutableEntity

java.lang.Object

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

All Implemented Interfaces:

Entity

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

Immutable implementation of Entity.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableEntity.Builder	builder() Creates a builder for ImmutableEntity.
static ImmutableEntity	copyOf(Entity instance) Creates an immutable copy of a Entity value.
String	description() Description of the entity.
String	entityIdentifier() Unique identifier for the entity.
boolean	equals(Object another) This instance is equal to all instances of ImmutableEntity that have equal attribute values.
int	hashCode() Computes a hash code from attributes: entityIdentifier, hasNestedEntities, label, description.
boolean	hasNestedEntities() Specifies whether the connector entity is a parent or a category and has more entities nested underneath it.
String	label() Label of the entity.
String	toString() Prints the immutable value Entity with attribute values.
ImmutableEntity	withDescription(String value) Copy the current immutable object by setting a value for the description attribute.
ImmutableEntity	withEntityIdentifier(String value) Copy the current immutable object by setting a value for the entityIdentifier attribute.
ImmutableEntity	withHasNestedEntities(boolean value) Copy the current immutable object by setting a value for the hasNestedEntities attribute.
ImmutableEntity	withLabel(String value) Copy the current immutable object by setting a value for the label attribute.

Methods inherited from class java.lang.Object

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

Method Detail

entityIdentifier

public String entityIdentifier()

Unique identifier for the entity. Can be entityId/ entityName / entityPath+name / entityUrl etc.

Specified by:

entityIdentifier in interface Entity

hasNestedEntities

public boolean hasNestedEntities()

Specifies whether the connector entity is a parent or a category and has more entities nested underneath it.

Specified by:

hasNestedEntities in interface Entity

label

@Nullable
public String label()

Label of the entity.

Specified by:

label in interface Entity

description

@Nullable
public String description()

Description of the entity.

Specified by:

description in interface Entity

withEntityIdentifier

public final ImmutableEntity withEntityIdentifier(String value)

Copy the current immutable object by setting a value for the entityIdentifier attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for entityIdentifier

Returns:

A modified copy of the this object

withHasNestedEntities

public final ImmutableEntity withHasNestedEntities(boolean value)

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

Parameters:

value - A new value for hasNestedEntities

Returns:

A modified copy of the this object

withLabel

public final ImmutableEntity withLabel(@Nullable
                                       String value)

Copy the current immutable object by setting a value for the label attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for label (can be null)

Returns:

A modified copy of the this object

withDescription

public final ImmutableEntity withDescription(@Nullable
                                             String value)

Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for description (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableEntity 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: entityIdentifier, hasNestedEntities, label, description.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Entity with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableEntity copyOf(Entity instance)

Creates an immutable copy of a Entity 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 Entity instance

builder

public static ImmutableEntity.Builder builder()

Creates a builder for ImmutableEntity.

 ImmutableEntity.builder()
    .entityIdentifier(String) // required entityIdentifier
    .hasNestedEntities(boolean) // required hasNestedEntities
    .label(String | null) // nullable label
    .description(String | null) // nullable description
    .build();
 

Returns:

A new ImmutableEntity builder