Class Campaign

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

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the campaign.

      Returns:
      The name of the campaign.

    • campaignArn

      public final String campaignArn()

      The Amazon Resource Name (ARN) of the campaign.

      Returns:
      The Amazon Resource Name (ARN) of the campaign.

    • solutionVersionArn

      public final String solutionVersionArn()

      The Amazon Resource Name (ARN) of the solution version the campaign uses.

      Returns:
      The Amazon Resource Name (ARN) of the solution version the campaign uses.

    • minProvisionedTPS

      public final Integer minProvisionedTPS()

      Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

      Returns:
      Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

    • campaignConfig

      public final CampaignConfig campaignConfig()

      The configuration details of a campaign.

      Returns:
      The configuration details of a campaign.

    • status

      public final String status()

      The status of the campaign.

      A campaign can be in one of the following states:

      • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • DELETE PENDING > DELETE IN_PROGRESS

      Returns:
      The status of the campaign.

      A campaign can be in one of the following states:

      • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • DELETE PENDING > DELETE IN_PROGRESS

    • failureReason

      public final String failureReason()

      If a campaign fails, the reason behind the failure.

      Returns:
      If a campaign fails, the reason behind the failure.

    • creationDateTime

      public final Instant creationDateTime()

      The date and time (in Unix format) that the campaign was created.

      Returns:
      The date and time (in Unix format) that the campaign was created.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time (in Unix format) that the campaign was last updated.

      Returns:
      The date and time (in Unix format) that the campaign was last updated.

    • latestCampaignUpdate

      public final CampaignUpdateSummary latestCampaignUpdate()

      Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

      The latestCampaignUpdate field is only returned when the campaign has had at least one UpdateCampaign call.

      Returns:
      Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

      The latestCampaignUpdate field is only returned when the campaign has had at least one UpdateCampaign call.

    • toBuilder

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

    • builder

      public static Campaign.Builder builder()

    • serializableBuilderClass

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