Class: Aws::Pinpoint::Types::TreatmentResource

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::TreatmentResource

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #custom_delivery_configuration ⇒ Types::CustomDeliveryConfiguration

  The delivery configuration settings for sending the treatment through a custom channel.

• #id ⇒ String

  The unique identifier for the treatment.

• #message_configuration ⇒ Types::MessageConfiguration

  The message configuration settings for the treatment.

• #schedule ⇒ Types::Schedule

  The schedule settings for the treatment.

• #size_percent ⇒ Integer

  The allocated percentage of users (segment members) that the treatment is sent to.

• #state ⇒ Types::CampaignState

  The current status of the treatment.

• #template_configuration ⇒ Types::TemplateConfiguration

  The message template to use for the treatment.

• #treatment_description ⇒ String

  The custom description of the treatment.

• #treatment_name ⇒ String

  The custom name of the treatment.

Instance Attribute Details

#custom_delivery_configuration ⇒ Types::CustomDeliveryConfiguration

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

Returns:

• (Types::CustomDeliveryConfiguration)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the treatment.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#message_configuration ⇒ Types::MessageConfiguration

The message configuration settings for the treatment.

Returns:

• (Types::MessageConfiguration)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::Schedule

The schedule settings for the treatment.

Returns:

• (Types::Schedule)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#size_percent ⇒ Integer

The allocated percentage of users (segment members) that the treatment is sent to.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::CampaignState

The current status of the treatment.

Returns:

• (Types::CampaignState)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#template_configuration ⇒ Types::TemplateConfiguration

The message template to use for the treatment.

Returns:

• (Types::TemplateConfiguration)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_description ⇒ String

The custom description of the treatment.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_name ⇒ String

The custom name of the treatment.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12180

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end