Package software.amazon.awssdk.services.connect.model

Class Reference

java.lang.Object

software.amazon.awssdk.services.connect.model.Reference

All Implemented Interfaces:

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

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

Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Reference.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the reference
static Reference.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Reference.Builder>	serializableBuilderClass()
ReferenceStatus	status()	Status of the attachment reference type.
String	statusAsString()	Status of the attachment reference type.
String	statusReason()	Relevant details why the reference was not successfully created.
Reference.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ReferenceType	type()	The type of the reference.
String	typeAsString()	The type of the reference.
String	value()	A valid value for the reference.

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

value

public final String value()

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

Returns:

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

type

public final ReferenceType type()

The type of the reference. DATE must be of type Epoch timestamp.

If the service returns an enum value that is not available in the current SDK version, type will return ReferenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the reference. DATE must be of type Epoch timestamp.

See Also:

ReferenceType

typeAsString

public final String typeAsString()

The type of the reference. DATE must be of type Epoch timestamp.

If the service returns an enum value that is not available in the current SDK version, type will return ReferenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the reference. DATE must be of type Epoch timestamp.

See Also:

ReferenceType

status

public final ReferenceStatus status()

Status of the attachment reference type.

If the service returns an enum value that is not available in the current SDK version, status will return ReferenceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Status of the attachment reference type.

See Also:

ReferenceStatus

statusAsString

public final String statusAsString()

Status of the attachment reference type.

If the service returns an enum value that is not available in the current SDK version, status will return ReferenceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Status of the attachment reference type.

See Also:

ReferenceStatus

arn

public final String arn()

The Amazon Resource Name (ARN) of the reference

Returns:

The Amazon Resource Name (ARN) of the reference

statusReason

public final String statusReason()

Relevant details why the reference was not successfully created.

Returns:

Relevant details why the reference was not successfully created.

toBuilder

public Reference.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Reference.Builder,Reference>

builder

public static Reference.Builder builder()

serializableBuilderClass

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