Package software.amazon.awssdk.services.personalize.model

Class CreateCampaignRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.personalize.model.PersonalizeRequest

software.amazon.awssdk.services.personalize.model.CreateCampaignRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateCampaignRequest
extends PersonalizeRequest
implements ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCampaignRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateCampaignRequest.Builder	builder()
CampaignConfig	campaignConfig()	The configuration details of a campaign.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Integer	minProvisionedTPS()	Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
String	name()	A name for the new campaign.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCampaignRequest.Builder>	serializableBuilderClass()
String	solutionVersionArn()	The Amazon Resource Name (ARN) of the solution version to deploy.
List<Tag>	tags()	A list of tags to apply to the campaign.
CreateCampaignRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

A name for the new campaign. The campaign name must be unique within your account.

Returns:

A name for the new campaign. The campaign name must be unique within your account.

solutionVersionArn

public final String solutionVersionArn()

The Amazon Resource Name (ARN) of the solution version to deploy.

Returns:

The Amazon Resource Name (ARN) of the solution version to deploy.

minProvisionedTPS

public final Integer minProvisionedTPS()

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. 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 that Amazon Personalize will support. 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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of tags to apply to the campaign.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags to apply to the campaign.

toBuilder

public CreateCampaignRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

Specified by:

toBuilder in class PersonalizeRequest

builder

public static CreateCampaignRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo