ReferenceSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.connect.model.ReferenceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReferenceSummary.Builder,ReferenceSummary>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ReferenceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReferenceSummary.Builder,ReferenceSummary>
```
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReferenceSummary.Builder

static class ReferenceSummary.Type

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReferenceSummary.Builder`
`static class`	`ReferenceSummary.Type`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachmentReference`	`attachment()` Information about the reference when the `referenceType` is `ATTACHMENT`.
`static ReferenceSummary.Builder`	`builder()`
`DateReference`	`date()` Information about a reference when the `referenceType` is `DATE`.
`EmailReference`	`email()` Information about a reference when the `referenceType` is `EMAIL`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`static ReferenceSummary`	`fromAttachment(AttachmentReference attachment)` Create an instance of this class with `attachment()` initialized to the given value.
`static ReferenceSummary`	`fromAttachment(Consumer<AttachmentReference.Builder> attachment)` Create an instance of this class with `attachment()` initialized to the given value.
`static ReferenceSummary`	`fromDate(Consumer<DateReference.Builder> date)` Create an instance of this class with `date()` initialized to the given value.
`static ReferenceSummary`	`fromDate(DateReference date)` Create an instance of this class with `date()` initialized to the given value.
`static ReferenceSummary`	`fromEmail(Consumer<EmailReference.Builder> email)` Create an instance of this class with `email()` initialized to the given value.
`static ReferenceSummary`	`fromEmail(EmailReference email)` Create an instance of this class with `email()` initialized to the given value.
`static ReferenceSummary`	`fromNumber(Consumer<NumberReference.Builder> number)` Create an instance of this class with `number()` initialized to the given value.
`static ReferenceSummary`	`fromNumber(NumberReference number)` Create an instance of this class with `number()` initialized to the given value.
`static ReferenceSummary`	`fromString(Consumer<StringReference.Builder> string)` Create an instance of this class with `string()` initialized to the given value.
`static ReferenceSummary`	`fromString(StringReference string)` Create an instance of this class with `string()` initialized to the given value.
`static ReferenceSummary`	`fromUrl(Consumer<UrlReference.Builder> url)` Create an instance of this class with `url()` initialized to the given value.
`static ReferenceSummary`	`fromUrl(UrlReference url)` Create an instance of this class with `url()` initialized to the given value.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`NumberReference`	`number()` Information about a reference when the `referenceType` is `NUMBER`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReferenceSummary.Builder>`	`serializableBuilderClass()`
`StringReference`	`string()` Information about a reference when the `referenceType` is `STRING`.
`ReferenceSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ReferenceSummary.Type`	`type()` Retrieve an enum value representing which member of this object is populated.
`UrlReference`	`url()` Information about the reference when the `referenceType` is `URL`.

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
  - url
```
public final UrlReference url()
```
    Information about the reference when the referenceType is URL. Otherwise, null.
    
    Returns:
    
    Information about the reference when the referenceType is URL. Otherwise, null.
  - attachment
```
public final AttachmentReference attachment()
```
    Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
    
    Returns:
    
    Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
  - string
```
public final StringReference string()
```
    Information about a reference when the referenceType is STRING. Otherwise, null.
    
    Returns:
    
    Information about a reference when the referenceType is STRING. Otherwise, null.
  - number
```
public final NumberReference number()
```
    Information about a reference when the referenceType is NUMBER. Otherwise, null.
    
    Returns:
    
    Information about a reference when the referenceType is NUMBER. Otherwise, null.
  - date
```
public final DateReference date()
```
    Information about a reference when the referenceType is DATE. Otherwise, null.
    
    Returns:
    
    Information about a reference when the referenceType is DATE. Otherwise, null.
  - email
```
public final EmailReference email()
```
    Information about a reference when the referenceType is EMAIL. Otherwise, null.
    
    Returns:
    
    Information about a reference when the referenceType is EMAIL. Otherwise, null.
  - toBuilder
```
public ReferenceSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReferenceSummary.Builder,ReferenceSummary>
  - builder
```
public static ReferenceSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReferenceSummary.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)
```
  - fromUrl
```
public static ReferenceSummary fromUrl(UrlReference url)
```
    Create an instance of this class with url() initialized to the given value.
    Information about the reference when the referenceType is URL. Otherwise, null.
    
    Parameters:
    
    url - Information about the reference when the referenceType is URL. Otherwise, null.
  - fromUrl
```
public static ReferenceSummary fromUrl(Consumer<UrlReference.Builder> url)
```
    Create an instance of this class with url() initialized to the given value.
    Information about the reference when the referenceType is URL. Otherwise, null.
    
    Parameters:
    
    url - Information about the reference when the referenceType is URL. Otherwise, null.
  - fromAttachment
```
public static ReferenceSummary fromAttachment(AttachmentReference attachment)
```
    Create an instance of this class with attachment() initialized to the given value.
    Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
    
    Parameters:
    
    attachment - Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
  - fromAttachment
```
public static ReferenceSummary fromAttachment(Consumer<AttachmentReference.Builder> attachment)
```
    Create an instance of this class with attachment() initialized to the given value.
    Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
    
    Parameters:
    
    attachment - Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
  - fromString
```
public static ReferenceSummary fromString(StringReference string)
```
    Create an instance of this class with string() initialized to the given value.
    Information about a reference when the referenceType is STRING. Otherwise, null.
    
    Parameters:
    
    string - Information about a reference when the referenceType is STRING. Otherwise, null.
  - fromString
```
public static ReferenceSummary fromString(Consumer<StringReference.Builder> string)
```
    Create an instance of this class with string() initialized to the given value.
    Information about a reference when the referenceType is STRING. Otherwise, null.
    
    Parameters:
    
    string - Information about a reference when the referenceType is STRING. Otherwise, null.
  - fromNumber
```
public static ReferenceSummary fromNumber(NumberReference number)
```
    Create an instance of this class with number() initialized to the given value.
    Information about a reference when the referenceType is NUMBER. Otherwise, null.
    
    Parameters:
    
    number - Information about a reference when the referenceType is NUMBER. Otherwise, null.
  - fromNumber
```
public static ReferenceSummary fromNumber(Consumer<NumberReference.Builder> number)
```
    Create an instance of this class with number() initialized to the given value.
    Information about a reference when the referenceType is NUMBER. Otherwise, null.
    
    Parameters:
    
    number - Information about a reference when the referenceType is NUMBER. Otherwise, null.
  - fromDate
```
public static ReferenceSummary fromDate(DateReference date)
```
    Create an instance of this class with date() initialized to the given value.
    Information about a reference when the referenceType is DATE. Otherwise, null.
    
    Parameters:
    
    date - Information about a reference when the referenceType is DATE. Otherwise, null.
  - fromDate
```
public static ReferenceSummary fromDate(Consumer<DateReference.Builder> date)
```
    Create an instance of this class with date() initialized to the given value.
    Information about a reference when the referenceType is DATE. Otherwise, null.
    
    Parameters:
    
    date - Information about a reference when the referenceType is DATE. Otherwise, null.
  - fromEmail
```
public static ReferenceSummary fromEmail(EmailReference email)
```
    Create an instance of this class with email() initialized to the given value.
    Information about a reference when the referenceType is EMAIL. Otherwise, null.
    
    Parameters:
    
    email - Information about a reference when the referenceType is EMAIL. Otherwise, null.
  - fromEmail
```
public static ReferenceSummary fromEmail(Consumer<EmailReference.Builder> email)
```
    Create an instance of this class with email() initialized to the given value.
    Information about a reference when the referenceType is EMAIL. Otherwise, null.
    
    Parameters:
    
    email - Information about a reference when the referenceType is EMAIL. Otherwise, null.
  - type
```
public ReferenceSummary.Type type()
```
    Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ReferenceSummary.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ReferenceSummary.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ReferenceSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

url

attachment

string

number

date

email

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

fromUrl

fromUrl

fromAttachment

fromAttachment

fromString

fromString

fromNumber

fromNumber

fromDate

fromDate

fromEmail

fromEmail

type

sdkFields