software.amazon.awssdk.services.clouddirectory.model

Class TypedLinkFacet

java.lang.Object

software.amazon.awssdk.services.clouddirectory.model.TypedLinkFacet

All Implemented Interfaces:

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

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

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TypedLinkFacet.Builder

Method Summary

Modifier and Type	Method and Description
List<TypedLinkAttributeDefinition>	attributes() A set of key-value pairs associated with the typed link.
static TypedLinkFacet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
boolean	hasIdentityAttributeOrder() For responses, this returns true if the service returned a value for the IdentityAttributeOrder property.
List<String>	identityAttributeOrder() The set of attributes that distinguish links made from this facet from each other, in the order of significance.
String	name() The unique name of the typed link facet.
List<SdkField<?>>	sdkFields()
static Class<? extends TypedLinkFacet.Builder>	serializableBuilderClass()
TypedLinkFacet.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

name

public final String name()

The unique name of the typed link facet.

Returns:

The unique name of the typed link facet.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes 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.

attributes

public final List<TypedLinkAttributeDefinition> attributes()

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

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 hasAttributes() method.

Returns:

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

hasIdentityAttributeOrder

public final boolean hasIdentityAttributeOrder()

For responses, this returns true if the service returned a value for the IdentityAttributeOrder 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.

identityAttributeOrder

public final List<String> identityAttributeOrder()

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

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 hasIdentityAttributeOrder() method.

Returns:

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

toBuilder

public TypedLinkFacet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TypedLinkFacet.Builder,TypedLinkFacet>

builder

public static TypedLinkFacet.Builder builder()

serializableBuilderClass

public static Class<? extends TypedLinkFacet.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