Class ReputationEntity

java.lang.Object
software.amazon.awssdk.services.sesv2.model.ReputationEntity
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReputationEntity.Builder,ReputationEntity>
@Generated("software.amazon.awssdk:codegen") public final class ReputationEntity extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReputationEntity.Builder,ReputationEntity>

An object that contains information about a reputation entity, including its reference, type, policy, status records, and reputation impact.

See Also:

  • Method Details

    • reputationEntityReference

      public final String reputationEntityReference()

      The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

      Returns:
      The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

    • reputationEntityType

      public final ReputationEntityType reputationEntityType()

      The type of reputation entity. Currently, only RESOURCE type entities are supported.

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

      Returns:
      The type of reputation entity. Currently, only RESOURCE type entities are supported.
      See Also:

    • reputationEntityTypeAsString

      public final String reputationEntityTypeAsString()

      The type of reputation entity. Currently, only RESOURCE type entities are supported.

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

      Returns:
      The type of reputation entity. Currently, only RESOURCE type entities are supported.
      See Also:

    • reputationManagementPolicy

      public final String reputationManagementPolicy()

      The Amazon Resource Name (ARN) of the reputation management policy applied to this entity. This is an Amazon Web Services Amazon SES-managed policy.

      Returns:
      The Amazon Resource Name (ARN) of the reputation management policy applied to this entity. This is an Amazon Web Services Amazon SES-managed policy.

    • customerManagedStatus

      public final StatusRecord customerManagedStatus()

      The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

      Returns:
      The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

    • awsSesManagedStatus

      public final StatusRecord awsSesManagedStatus()

      The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

      Returns:
      The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

    • sendingStatusAggregate

      public final SendingStatus sendingStatusAggregate()

      The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending.

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

      Returns:
      The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending.
      See Also:

    • sendingStatusAggregateAsString

      public final String sendingStatusAggregateAsString()

      The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending.

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

      Returns:
      The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending.
      See Also:

    • reputationImpact

      public final RecommendationImpact reputationImpact()

      The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation.

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

      Returns:
      The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation.
      See Also:

    • reputationImpactAsString

      public final String reputationImpactAsString()

      The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation.

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

      Returns:
      The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation.
      See Also:

    • toBuilder

      public ReputationEntity.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<ReputationEntity.Builder,ReputationEntity>
      Returns:
      a builder for type T

    • builder

      public static ReputationEntity.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReputationEntity.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

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

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