Package software.amazon.awssdk.services.customerprofiles.model

Class GetSegmentMembershipResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

software.amazon.awssdk.services.customerprofiles.model.GetSegmentMembershipResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSegmentMembershipResponse.Builder,GetSegmentMembershipResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSegmentMembershipResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetSegmentMembershipResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ProfileQueryFailures>	failures()	An array of maps where each contains a response per profile failed for the request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailures()	For responses, this returns true if the service returned a value for the Failures property.
int	hashCode()
boolean	hasProfiles()	For responses, this returns true if the service returned a value for the Profiles property.
List<ProfileQueryResult>	profiles()	An array of maps where each contains a response per profile requested.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	segmentDefinitionName()	The unique name of the segment definition.
static Class<? extends GetSegmentMembershipResponse.Builder>	serializableBuilderClass()
GetSegmentMembershipResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

segmentDefinitionName

public final String segmentDefinitionName()

The unique name of the segment definition.

Returns:

The unique name of the segment definition.

hasProfiles

public final boolean hasProfiles()

For responses, this returns true if the service returned a value for the Profiles 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.

profiles

public final List<ProfileQueryResult> profiles()

An array of maps where each contains a response per profile requested.

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 hasProfiles() method.

Returns:

An array of maps where each contains a response per profile requested.

hasFailures

public final boolean hasFailures()

For responses, this returns true if the service returned a value for the Failures 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.

failures

public final List<ProfileQueryFailures> failures()

An array of maps where each contains a response per profile failed for the request.

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 hasFailures() method.

Returns:

An array of maps where each contains a response per profile failed for the request.

toBuilder

public GetSegmentMembershipResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSegmentMembershipResponse.Builder,GetSegmentMembershipResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetSegmentMembershipResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo