Class GetProfileObjectTypeResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetProfileObjectTypeResponse.Builder,
GetProfileObjectTypeResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.builder()
final Instant
The timestamp of when the domain was created.final String
The description of the profile object type.final String
The customer-provided key to encrypt the profile object that will be created in this profile object type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of days until the data in the object expires.final Map
<String, ObjectTypeField> fields()
A map of the name and ObjectType field.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the Fields property.final int
hashCode()
final boolean
hasKeys()
For responses, this returns true if the service returned a value for the Keys property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Map
<String, List<ObjectTypeKey>> keys()
A list of unique keys that can be used to map data to the profile.final Instant
The timestamp of when the domain was most recently edited.final String
The name of the profile object type.static Class
<? extends GetProfileObjectTypeResponse.Builder> final String
The format of yoursourceLastUpdatedTimestamp
that was previously set up.tags()
The tags used to organize, track, or control access for this resource.final String
A unique identifier for the object template.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.Methods inherited from class software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
objectTypeName
The name of the profile object type.
- Returns:
- The name of the profile object type.
-
description
The description of the profile object type.
- Returns:
- The description of the profile object type.
-
templateId
A unique identifier for the object template.
- Returns:
- A unique identifier for the object template.
-
expirationDays
The number of days until the data in the object expires.
- Returns:
- The number of days until the data in the object expires.
-
encryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type.
- Returns:
- The customer-provided key to encrypt the profile object that will be created in this profile object type.
-
allowProfileCreation
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is
FALSE
. If the AllowProfileCreation flag is set toFALSE
, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE
, and if no match is found, then the service creates a new standard profile.- Returns:
- Indicates whether a profile should be created when data is received if one doesn’t exist for an object of
this type. The default is
FALSE
. If the AllowProfileCreation flag is set toFALSE
, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE
, and if no match is found, then the service creates a new standard profile.
-
sourceLastUpdatedTimestampFormat
The format of your
sourceLastUpdatedTimestamp
that was previously set up.- Returns:
- The format of your
sourceLastUpdatedTimestamp
that was previously set up.
-
hasFields
public final boolean hasFields()For responses, this returns true if the service returned a value for the Fields property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
fields
A map of the name and ObjectType field.
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
hasFields()
method.- Returns:
- A map of the name and ObjectType field.
-
hasKeys
public final boolean hasKeys()For responses, this returns true if the service returned a value for the Keys property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
keys
A list of unique keys that can be used to map data to the profile.
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
hasKeys()
method.- Returns:
- A list of unique keys that can be used to map data to the profile.
-
createdAt
The timestamp of when the domain was created.
- Returns:
- The timestamp of when the domain was created.
-
lastUpdatedAt
The timestamp of when the domain was most recently edited.
- Returns:
- The timestamp of when the domain was most recently edited.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tags
The tags used to organize, track, or control access for this resource.
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
hasTags()
method.- Returns:
- The tags used to organize, track, or control access for this resource.
-
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<GetProfileObjectTypeResponse.Builder,
GetProfileObjectTypeResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-