software.amazon.awssdk.services.customerprofiles.model

Interface ListProfileObjectsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListProfileObjectsRequest.Builder,ListProfileObjectsRequest>, CustomerProfilesRequest.Builder, SdkBuilder<ListProfileObjectsRequest.Builder,ListProfileObjectsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListProfileObjectsRequest

public static interface ListProfileObjectsRequest.Builder
extends CustomerProfilesRequest.Builder, SdkPojo, CopyableBuilder<ListProfileObjectsRequest.Builder,ListProfileObjectsRequest>

Method Summary

Modifier and Type	Method and Description
ListProfileObjectsRequest.Builder	domainName(String domainName) The unique name of the domain.
ListProfileObjectsRequest.Builder	maxResults(Integer maxResults) The maximum number of objects returned per page.
ListProfileObjectsRequest.Builder	nextToken(String nextToken) The pagination token from the previous call to ListProfileObjects.
default ListProfileObjectsRequest.Builder	objectFilter(Consumer<ObjectFilter.Builder> objectFilter) Applies a filter to the response to include profile objects with the specified index values.
ListProfileObjectsRequest.Builder	objectFilter(ObjectFilter objectFilter) Applies a filter to the response to include profile objects with the specified index values.
ListProfileObjectsRequest.Builder	objectTypeName(String objectTypeName) The name of the profile object type.
ListProfileObjectsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListProfileObjectsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListProfileObjectsRequest.Builder	profileId(String profileId) The unique identifier of a customer profile.

Methods inherited from interface software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

nextToken

ListProfileObjectsRequest.Builder nextToken(String nextToken)

The pagination token from the previous call to ListProfileObjects.

Parameters:

nextToken - The pagination token from the previous call to ListProfileObjects.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

ListProfileObjectsRequest.Builder maxResults(Integer maxResults)

The maximum number of objects returned per page.

Parameters:

maxResults - The maximum number of objects returned per page.

Returns:

Returns a reference to this object so that method calls can be chained together.

domainName

ListProfileObjectsRequest.Builder domainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectTypeName

ListProfileObjectsRequest.Builder objectTypeName(String objectTypeName)

The name of the profile object type.

Parameters:

objectTypeName - The name of the profile object type.

Returns:

Returns a reference to this object so that method calls can be chained together.

profileId

ListProfileObjectsRequest.Builder profileId(String profileId)

The unique identifier of a customer profile.

Parameters:

profileId - The unique identifier of a customer profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectFilter

ListProfileObjectsRequest.Builder objectFilter(ObjectFilter objectFilter)

Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

Parameters:

objectFilter - Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectFilter

default ListProfileObjectsRequest.Builder objectFilter(Consumer<ObjectFilter.Builder> objectFilter)

Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

This is a convenience method that creates an instance of the ObjectFilter.Builder avoiding the need to create one manually via ObjectFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to objectFilter(ObjectFilter).

Parameters:

objectFilter - a consumer that will call methods on ObjectFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

objectFilter(ObjectFilter)

overrideConfiguration

ListProfileObjectsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListProfileObjectsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder