Interface CampaignSummary.Builder

  • Method Details

    • campaignId

      CampaignSummary.Builder campaignId(String campaignId)

      The campaign identifier.

      Parameters:
      campaignId - The campaign identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • arn

      The campaign ARN. Present on the summary so a caller can tag a campaign straight from a list result without a GetCampaign per row — the same reason the audit timestamps are here.

      Parameters:
      arn - The campaign ARN. Present on the summary so a caller can tag a campaign straight from a list result without a GetCampaign per row — the same reason the audit timestamps are here.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      The display name.

      Parameters:
      name - The display name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • state

      The campaign's state, derived on every read from EndOn and its assets. See CampaignState.

      Parameters:
      state - The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • state

      The campaign's state, derived on every read from EndOn and its assets. See CampaignState.

      Parameters:
      state - The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • language

      CampaignSummary.Builder language(String language)

      The language the campaign's assets are written and typeset in. See Campaign$Language.

      Parameters:
      language - The language the campaign's assets are written and typeset in. See Campaign$Language.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • language

      The language the campaign's assets are written and typeset in. See Campaign$Language.

      Parameters:
      language - The language the campaign's assets are written and typeset in. See Campaign$Language.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • startOn

      CampaignSummary.Builder startOn(String startOn)

      The first day of the campaign's run window.

      Parameters:
      startOn - The first day of the campaign's run window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endOn

      The last day of the campaign's run window.

      Parameters:
      endOn - The last day of the campaign's run window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdAt

      CampaignSummary.Builder createdAt(Instant createdAt)

      Creation timestamp. Present on the summary so a caller can order a list by recency without reading each campaign in full.

      Parameters:
      createdAt - Creation timestamp. Present on the summary so a caller can order a list by recency without reading each campaign in full.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      CampaignSummary.Builder updatedAt(Instant updatedAt)

      Last update timestamp. Present on the summary for the same reason as CreatedAt.

      Parameters:
      updatedAt - Last update timestamp. Present on the summary for the same reason as CreatedAt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.