Class Campaign
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Campaign.Builder,
Campaign>
An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Campaign.Builder
builder()
final String
The Amazon Resource Name (ARN) of the campaign.final CampaignConfig
The configuration details of a campaign.final Instant
The date and time (in Unix format) that the campaign was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If a campaign fails, the reason behind the failure.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The date and time (in Unix format) that the campaign was last updated.final CampaignUpdateSummary
Returns the value of the LatestCampaignUpdate property for this object.final Integer
Specifies the requested minimum provisioned transactions (recommendations) per second.final String
name()
The name of the campaign.static Class
<? extends Campaign.Builder> final String
The Amazon Resource Name (ARN) of the solution version the campaign uses.final String
status()
The status of the campaign.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the campaign.
- Returns:
- The name of the campaign.
-
campaignArn
The Amazon Resource Name (ARN) of the campaign.
- Returns:
- The Amazon Resource Name (ARN) of the campaign.
-
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
Specifies the requested minimum provisioned transactions (recommendations) per second. A high
minProvisionedTPS
will increase your bill. We recommend starting with 1 forminProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPS
as necessary.- Returns:
- Specifies the requested minimum provisioned transactions (recommendations) per second. A high
minProvisionedTPS
will increase your bill. We recommend starting with 1 forminProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPS
as necessary.
-
campaignConfig
The configuration details of a campaign.
- Returns:
- The configuration details of a campaign.
-
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
If a campaign fails, the reason behind the failure.
- Returns:
- If a campaign fails, the reason behind the failure.
-
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
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
Returns the value of the LatestCampaignUpdate property for this object.- Returns:
- The value of the LatestCampaignUpdate property for this object.
-
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 interfaceToCopyableBuilder<Campaign.Builder,
Campaign> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-