Class GetCalculatedAttributeDefinitionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse
software.amazon.awssdk.services.customerprofiles.model.GetCalculatedAttributeDefinitionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCalculatedAttributeDefinitionResponse.Builder,GetCalculatedAttributeDefinitionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetCalculatedAttributeDefinitionResponse extends CustomerProfilesResponse implements ToCopyableBuilder<GetCalculatedAttributeDefinitionResponse.Builder,GetCalculatedAttributeDefinitionResponse>

  • Method Details

    • calculatedAttributeName

      public final String calculatedAttributeName()

      The unique name of the calculated attribute.

      Returns:
      The unique name of the calculated attribute.

    • displayName

      public final String displayName()

      The display name of the calculated attribute.

      Returns:
      The display name of the calculated attribute.

    • description

      public final String description()

      The description of the calculated attribute.

      Returns:
      The description of the calculated attribute.

    • createdAt

      public final Instant createdAt()

      The timestamp of when the calculated attribute definition was created.

      Returns:
      The timestamp of when the calculated attribute definition was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp of when the calculated attribute definition was most recently edited.

      Returns:
      The timestamp of when the calculated attribute definition was most recently edited.

    • statistic

      public final Statistic statistic()

      The aggregation operation to perform for the calculated attribute.

      If the service returns an enum value that is not available in the current SDK version, statistic will return Statistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

      Returns:
      The aggregation operation to perform for the calculated attribute.
      See Also:

    • statisticAsString

      public final String statisticAsString()

      The aggregation operation to perform for the calculated attribute.

      If the service returns an enum value that is not available in the current SDK version, statistic will return Statistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

      Returns:
      The aggregation operation to perform for the calculated attribute.
      See Also:

    • filter

      public final Filter filter()

      The filter assigned to this calculated attribute definition.

      Returns:
      The filter assigned to this calculated attribute definition.

    • conditions

      public final Conditions conditions()

      The conditions including range, object count, and threshold for the calculated attribute.

      Returns:
      The conditions including range, object count, and threshold for the calculated attribute.

    • attributeDetails

      public final AttributeDetails attributeDetails()

      Mathematical expression and a list of attribute items specified in that expression.

      Returns:
      Mathematical expression and a list of attribute items specified in that expression.

    • useHistoricalData

      public final Boolean useHistoricalData()

      Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

      Returns:
      Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

    • status

      public final ReadinessStatus status()

      Status of the Calculated Attribute creation (whether all historical data has been indexed).

      If the service returns an enum value that is not available in the current SDK version, status will return ReadinessStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Status of the Calculated Attribute creation (whether all historical data has been indexed).
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the Calculated Attribute creation (whether all historical data has been indexed).

      If the service returns an enum value that is not available in the current SDK version, status will return ReadinessStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Status of the Calculated Attribute creation (whether all historical data has been indexed).
      See Also:

    • readiness

      public final Readiness readiness()

      Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

      Returns:
      Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

    • 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

      public GetCalculatedAttributeDefinitionResponse.Builder 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<GetCalculatedAttributeDefinitionResponse.Builder,GetCalculatedAttributeDefinitionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetCalculatedAttributeDefinitionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCalculatedAttributeDefinitionResponse.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.