Class PutProfileObjectTypeResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutProfileObjectTypeResponse.Builder,PutProfileObjectTypeResponse>

@Generated("software.amazon.awssdk:codegen") public final class PutProfileObjectTypeResponse extends CustomerProfilesResponse implements ToCopyableBuilder<PutProfileObjectTypeResponse.Builder,PutProfileObjectTypeResponse>
  • Method Details

    • objectTypeName

      public final String objectTypeName()

      The name of the profile object type.

      Returns:
      The name of the profile object type.
    • description

      public final String description()

      Description of the profile object type.

      Returns:
      Description of the profile object type.
    • templateId

      public final String templateId()

      A unique identifier for the object template.

      Returns:
      A unique identifier for the object template.
    • expirationDays

      public final Integer 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

      public final String 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

      public final Boolean 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 to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, 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 to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
    • sourceLastUpdatedTimestampFormat

      public final String sourceLastUpdatedTimestampFormat()

      The format of your sourceLastUpdatedTimestamp that was previously set up in fields that were parsed using SimpleDateFormat. If you have sourceLastUpdatedTimestamp in your field, you must set up sourceLastUpdatedTimestampFormat.

      Returns:
      The format of your sourceLastUpdatedTimestamp that was previously set up in fields that were parsed using SimpleDateFormat. If you have sourceLastUpdatedTimestamp in your field, you must set up sourceLastUpdatedTimestampFormat.
    • 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 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.
    • fields

      public final Map<String,ObjectTypeField> 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 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.
    • keys

      public final Map<String,List<ObjectTypeKey>> 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

      public final Instant createdAt()

      The timestamp of when the domain was created.

      Returns:
      The timestamp of when the domain was created.
    • lastUpdatedAt

      public final Instant 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 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.
    • tags

      public final Map<String,String> 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 interface ToCopyableBuilder<PutProfileObjectTypeResponse.Builder,PutProfileObjectTypeResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static PutProfileObjectTypeResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends PutProfileObjectTypeResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.