Package software.amazon.awssdk.services.iotfleetwise.model

Class ListCampaignsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseRequest

software.amazon.awssdk.services.iotfleetwise.model.ListCampaignsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCampaignsRequest.Builder,ListCampaignsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCampaignsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListCampaignsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of items to return, between 1 and 100, inclusive.
String	nextToken()	A pagination token for the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCampaignsRequest.Builder>	serializableBuilderClass()
String	status()	Optional parameter to filter the results by the status of each created campaign in your account.
ListCampaignsRequest.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

nextToken

public final String nextToken()

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Returns:

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

maxResults

public final Integer maxResults()

The maximum number of items to return, between 1 and 100, inclusive.

Returns:

The maximum number of items to return, between 1 and 100, inclusive.

status

public final String status()

Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

Returns:

Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

toBuilder

public ListCampaignsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCampaignsRequest.Builder,ListCampaignsRequest>

Specified by:

toBuilder in class IoTFleetWiseRequest

builder

public static ListCampaignsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListCampaignsRequest.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