Class ReferenceSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionfinal AttachmentReference
Information about the reference when thereferenceType
isATTACHMENT
.static ReferenceSummary.Builder
builder()
final DateReference
date()
Information about a reference when thereferenceType
isDATE
.final EmailReference
email()
Information about a reference when thereferenceType
isEMAIL
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static ReferenceSummary
fromAttachment
(Consumer<AttachmentReference.Builder> attachment) Create an instance of this class withattachment()
initialized to the given value.static ReferenceSummary
fromAttachment
(AttachmentReference attachment) Create an instance of this class withattachment()
initialized to the given value.static ReferenceSummary
Create an instance of this class withdate()
initialized to the given value.static ReferenceSummary
fromDate
(DateReference date) Create an instance of this class withdate()
initialized to the given value.static ReferenceSummary
fromEmail
(Consumer<EmailReference.Builder> email) Create an instance of this class withemail()
initialized to the given value.static ReferenceSummary
fromEmail
(EmailReference email) Create an instance of this class withemail()
initialized to the given value.static ReferenceSummary
fromNumber
(Consumer<NumberReference.Builder> number) Create an instance of this class withnumber()
initialized to the given value.static ReferenceSummary
fromNumber
(NumberReference number) Create an instance of this class withnumber()
initialized to the given value.static ReferenceSummary
fromString
(Consumer<StringReference.Builder> string) Create an instance of this class withstring()
initialized to the given value.static ReferenceSummary
fromString
(StringReference string) Create an instance of this class withstring()
initialized to the given value.static ReferenceSummary
Create an instance of this class withurl()
initialized to the given value.static ReferenceSummary
fromUrl
(UrlReference url) Create an instance of this class withurl()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final NumberReference
number()
Information about a reference when thereferenceType
isNUMBER
.static Class
<? extends ReferenceSummary.Builder> final StringReference
string()
Information about a reference when thereferenceType
isSTRING
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.final UrlReference
url()
Information about the reference when thereferenceType
isURL
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
url
Information about the reference when the
referenceType
isURL
. Otherwise, null.- Returns:
- Information about the reference when the
referenceType
isURL
. Otherwise, null.
-
attachment
Information about the reference when the
referenceType
isATTACHMENT
. Otherwise, null.- Returns:
- Information about the reference when the
referenceType
isATTACHMENT
. Otherwise, null.
-
string
Information about a reference when the
referenceType
isSTRING
. Otherwise, null.- Returns:
- Information about a reference when the
referenceType
isSTRING
. Otherwise, null.
-
number
Information about a reference when the
referenceType
isNUMBER
. Otherwise, null.- Returns:
- Information about a reference when the
referenceType
isNUMBER
. Otherwise, null.
-
date
Information about a reference when the
referenceType
isDATE
. Otherwise, null.- Returns:
- Information about a reference when the
referenceType
isDATE
. Otherwise, null.
-
email
Information about a reference when the
referenceType
isEMAIL
. Otherwise, null.- Returns:
- Information about a reference when the
referenceType
isEMAIL
. Otherwise, null.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReferenceSummary.Builder,
ReferenceSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromUrl
Create an instance of this class withurl()
initialized to the given value.Information about the reference when the
referenceType
isURL
. Otherwise, null.- Parameters:
url
- Information about the reference when thereferenceType
isURL
. Otherwise, null.
-
fromUrl
Create an instance of this class withurl()
initialized to the given value.Information about the reference when the
referenceType
isURL
. Otherwise, null.- Parameters:
url
- Information about the reference when thereferenceType
isURL
. Otherwise, null.
-
fromAttachment
Create an instance of this class withattachment()
initialized to the given value.Information about the reference when the
referenceType
isATTACHMENT
. Otherwise, null.- Parameters:
attachment
- Information about the reference when thereferenceType
isATTACHMENT
. Otherwise, null.
-
fromAttachment
Create an instance of this class withattachment()
initialized to the given value.Information about the reference when the
referenceType
isATTACHMENT
. Otherwise, null.- Parameters:
attachment
- Information about the reference when thereferenceType
isATTACHMENT
. Otherwise, null.
-
fromString
Create an instance of this class withstring()
initialized to the given value.Information about a reference when the
referenceType
isSTRING
. Otherwise, null.- Parameters:
string
- Information about a reference when thereferenceType
isSTRING
. Otherwise, null.
-
fromString
Create an instance of this class withstring()
initialized to the given value.Information about a reference when the
referenceType
isSTRING
. Otherwise, null.- Parameters:
string
- Information about a reference when thereferenceType
isSTRING
. Otherwise, null.
-
fromNumber
Create an instance of this class withnumber()
initialized to the given value.Information about a reference when the
referenceType
isNUMBER
. Otherwise, null.- Parameters:
number
- Information about a reference when thereferenceType
isNUMBER
. Otherwise, null.
-
fromNumber
Create an instance of this class withnumber()
initialized to the given value.Information about a reference when the
referenceType
isNUMBER
. Otherwise, null.- Parameters:
number
- Information about a reference when thereferenceType
isNUMBER
. Otherwise, null.
-
fromDate
Create an instance of this class withdate()
initialized to the given value.Information about a reference when the
referenceType
isDATE
. Otherwise, null.- Parameters:
date
- Information about a reference when thereferenceType
isDATE
. Otherwise, null.
-
fromDate
Create an instance of this class withdate()
initialized to the given value.Information about a reference when the
referenceType
isDATE
. Otherwise, null.- Parameters:
date
- Information about a reference when thereferenceType
isDATE
. Otherwise, null.
-
fromEmail
Create an instance of this class withemail()
initialized to the given value.Information about a reference when the
referenceType
isEMAIL
. Otherwise, null.- Parameters:
email
- Information about a reference when thereferenceType
isEMAIL
. Otherwise, null.
-
fromEmail
Create an instance of this class withemail()
initialized to the given value.Information about a reference when the
referenceType
isEMAIL
. Otherwise, null.- Parameters:
email
- Information about a reference when thereferenceType
isEMAIL
. Otherwise, null.
-
type
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beReferenceSummary.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 beReferenceSummary.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-