software.amazon.awssdk.services.personalize.model

Class ListCampaignsRequest

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.ListCampaignsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCampaignsRequest.Builder,ListCampaignsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListCampaignsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListCampaignsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of campaigns to return.
String	nextToken() A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
List<SdkField<?>>	sdkFields()
static Class<? extends ListCampaignsRequest.Builder>	serializableBuilderClass()
String	solutionArn() The Amazon Resource Name (ARN) of the solution to list the campaigns for.
ListCampaignsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

solutionArn

public String solutionArn()

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

Returns:

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

nextToken

public String nextToken()

A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

Returns:

A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

maxResults

public Integer maxResults()

The maximum number of campaigns to return.

Returns:

The maximum number of campaigns to return.

toBuilder

public ListCampaignsRequest.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<ListCampaignsRequest.Builder,ListCampaignsRequest>

Specified by:

toBuilder in class PersonalizeRequest

Returns:

a builder for type T

builder

public static ListCampaignsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.