Package software.amazon.awssdk.services.customerprofiles.model

Class GetProfileObjectTypeResponse

    • Method Detail

      • 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()

        The description of the profile object type.

        Returns:
        The 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.

        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 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.

      • 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