software.amazon.awssdk.services.datazone.model

Class SearchUserProfilesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datazone.model.DataZoneRequest

software.amazon.awssdk.services.datazone.model.SearchUserProfilesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchUserProfilesRequest.Builder,SearchUserProfilesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchUserProfilesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchUserProfilesRequest.Builder	builder()
String	domainIdentifier() The identifier of the Amazon DataZone domain in which you want to search user profiles.
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 results to return in a single call to SearchUserProfiles.
String	nextToken() When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken.
List<SdkField<?>>	sdkFields()
String	searchText() Specifies the text for which to search.
static Class<? extends SearchUserProfilesRequest.Builder>	serializableBuilderClass()
SearchUserProfilesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UserSearchType	userType() Specifies the user type for the SearchUserProfiles action.
String	userTypeAsString() Specifies the user type for the SearchUserProfiles action.

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

domainIdentifier

public final String domainIdentifier()

The identifier of the Amazon DataZone domain in which you want to search user profiles.

Returns:

The identifier of the Amazon DataZone domain in which you want to search user profiles.

maxResults

public final Integer maxResults()

The maximum number of results to return in a single call to SearchUserProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchUserProfiles to list the next set of results.

Returns:

The maximum number of results to return in a single call to SearchUserProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchUserProfiles to list the next set of results.

nextToken

public final String nextToken()

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

Returns:

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

searchText

public final String searchText()

Specifies the text for which to search.

Returns:

Specifies the text for which to search.

userType

public final UserSearchType userType()

Specifies the user type for the SearchUserProfiles action.

If the service returns an enum value that is not available in the current SDK version, userType will return UserSearchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userTypeAsString().

Returns:

Specifies the user type for the SearchUserProfiles action.

See Also:

UserSearchType

userTypeAsString

public final String userTypeAsString()

Specifies the user type for the SearchUserProfiles action.

If the service returns an enum value that is not available in the current SDK version, userType will return UserSearchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userTypeAsString().

Returns:

Specifies the user type for the SearchUserProfiles action.

See Also:

UserSearchType

toBuilder

public SearchUserProfilesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchUserProfilesRequest.Builder,SearchUserProfilesRequest>

Specified by:

toBuilder in class DataZoneRequest

builder

public static SearchUserProfilesRequest.Builder builder()

serializableBuilderClass

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