software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of directoryservicedata Show documentation
Show all versions of directoryservicedata Show documentation
The AWS Java SDK for Directory Service Data module holds the client classes that are used for
communicating with Directory Service Data.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.directoryservicedata.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class SearchUsersRequest extends DirectoryServiceDataRequest implements
ToCopyableBuilder {
private static final SdkField DIRECTORY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DirectoryId").getter(getter(SearchUsersRequest::directoryId)).setter(setter(Builder::directoryId))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("DirectoryId").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(SearchUsersRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(SearchUsersRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField REALM_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Realm")
.getter(getter(SearchUsersRequest::realm)).setter(setter(Builder::realm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Realm").build()).build();
private static final SdkField> SEARCH_ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SearchAttributes")
.getter(getter(SearchUsersRequest::searchAttributes))
.setter(setter(Builder::searchAttributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SearchAttributes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SEARCH_STRING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SearchString").getter(getter(SearchUsersRequest::searchString)).setter(setter(Builder::searchString))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SearchString").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DIRECTORY_ID_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, REALM_FIELD, SEARCH_ATTRIBUTES_FIELD, SEARCH_STRING_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String directoryId;
private final Integer maxResults;
private final String nextToken;
private final String realm;
private final List searchAttributes;
private final String searchString;
private SearchUsersRequest(BuilderImpl builder) {
super(builder);
this.directoryId = builder.directoryId;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.realm = builder.realm;
this.searchAttributes = builder.searchAttributes;
this.searchString = builder.searchString;
}
/**
*
* The identifier (ID) of the directory that's associated with the user.
*
*
* @return The identifier (ID) of the directory that's associated with the user.
*/
public final String directoryId() {
return directoryId;
}
/**
*
* The maximum number of results to be returned per request.
*
*
* @return The maximum number of results to be returned per request.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* An encoded paging token for paginated calls that can be passed back to retrieve the next page.
*
*
* @return An encoded paging token for paginated calls that can be passed back to retrieve the next page.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The domain name that's associated with the user.
*
*
*
* This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is
* defined, only your Managed Microsoft AD users are returned.
*
*
* This value is case insensitive.
*
*
*
* @return The domain name that's associated with the user.
*
* This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no
* value is defined, only your Managed Microsoft AD users are returned.
*
*
* This value is case insensitive.
*
*/
public final String realm() {
return realm;
}
/**
* For responses, this returns true if the service returned a value for the SearchAttributes property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasSearchAttributes() {
return searchAttributes != null && !(searchAttributes instanceof SdkAutoConstructList);
}
/**
*
* One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service
* Data Attributes.
*
*
* 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 {@link #hasSearchAttributes} method.
*
*
* @return One or more data attributes that are used to search for a user. For a list of supported attributes, see
*
* Directory Service Data Attributes.
*/
public final List searchAttributes() {
return searchAttributes;
}
/**
*
* The attribute value that you want to search for.
*
*
*
* Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service
* Data Attributes.
*
*
*
* @return The attribute value that you want to search for.
*
* Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory
* Service Data Attributes.
*
*/
public final String searchString() {
return searchString;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(directoryId());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(realm());
hashCode = 31 * hashCode + Objects.hashCode(hasSearchAttributes() ? searchAttributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(searchString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SearchUsersRequest)) {
return false;
}
SearchUsersRequest other = (SearchUsersRequest) obj;
return Objects.equals(directoryId(), other.directoryId()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(realm(), other.realm())
&& hasSearchAttributes() == other.hasSearchAttributes()
&& Objects.equals(searchAttributes(), other.searchAttributes())
&& Objects.equals(searchString(), other.searchString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("SearchUsersRequest").add("DirectoryId", directoryId()).add("MaxResults", maxResults())
.add("NextToken", nextToken() == null ? null : "*** Sensitive Data Redacted ***").add("Realm", realm())
.add("SearchAttributes", hasSearchAttributes() ? searchAttributes() : null)
.add("SearchString", searchString() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DirectoryId":
return Optional.ofNullable(clazz.cast(directoryId()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "Realm":
return Optional.ofNullable(clazz.cast(realm()));
case "SearchAttributes":
return Optional.ofNullable(clazz.cast(searchAttributes()));
case "SearchString":
return Optional.ofNullable(clazz.cast(searchString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("DirectoryId", DIRECTORY_ID_FIELD);
map.put("MaxResults", MAX_RESULTS_FIELD);
map.put("NextToken", NEXT_TOKEN_FIELD);
map.put("Realm", REALM_FIELD);
map.put("SearchAttributes", SEARCH_ATTRIBUTES_FIELD);
map.put("SearchString", SEARCH_STRING_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((SearchUsersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DirectoryServiceDataRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier (ID) of the directory that's associated with the user.
*
*
* @param directoryId
* The identifier (ID) of the directory that's associated with the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder directoryId(String directoryId);
/**
*
* The maximum number of results to be returned per request.
*
*
* @param maxResults
* The maximum number of results to be returned per request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* An encoded paging token for paginated calls that can be passed back to retrieve the next page.
*
*
* @param nextToken
* An encoded paging token for paginated calls that can be passed back to retrieve the next page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The domain name that's associated with the user.
*
*
*
* This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no
* value is defined, only your Managed Microsoft AD users are returned.
*
*
* This value is case insensitive.
*
*
*
* @param realm
* The domain name that's associated with the user.
*
* This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When
* no value is defined, only your Managed Microsoft AD users are returned.
*
*
* This value is case insensitive.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder realm(String realm);
/**
*
* One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory
* Service Data Attributes.
*
*
* @param searchAttributes
* One or more data attributes that are used to search for a user. For a list of supported attributes,
* see
* Directory Service Data Attributes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchAttributes(Collection searchAttributes);
/**
*
* One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory
* Service Data Attributes.
*
*
* @param searchAttributes
* One or more data attributes that are used to search for a user. For a list of supported attributes,
* see
* Directory Service Data Attributes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchAttributes(String... searchAttributes);
/**
*
* The attribute value that you want to search for.
*
*
*
* Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory
* Service Data Attributes.
*
*
*
* @param searchString
* The attribute value that you want to search for.
*
* Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchString(String searchString);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DirectoryServiceDataRequest.BuilderImpl implements Builder {
private String directoryId;
private Integer maxResults;
private String nextToken;
private String realm;
private List searchAttributes = DefaultSdkAutoConstructList.getInstance();
private String searchString;
private BuilderImpl() {
}
private BuilderImpl(SearchUsersRequest model) {
super(model);
directoryId(model.directoryId);
maxResults(model.maxResults);
nextToken(model.nextToken);
realm(model.realm);
searchAttributes(model.searchAttributes);
searchString(model.searchString);
}
public final String getDirectoryId() {
return directoryId;
}
public final void setDirectoryId(String directoryId) {
this.directoryId = directoryId;
}
@Override
public final Builder directoryId(String directoryId) {
this.directoryId = directoryId;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final String getRealm() {
return realm;
}
public final void setRealm(String realm) {
this.realm = realm;
}
@Override
public final Builder realm(String realm) {
this.realm = realm;
return this;
}
public final Collection getSearchAttributes() {
if (searchAttributes instanceof SdkAutoConstructList) {
return null;
}
return searchAttributes;
}
public final void setSearchAttributes(Collection searchAttributes) {
this.searchAttributes = LdapDisplayNameListCopier.copy(searchAttributes);
}
@Override
public final Builder searchAttributes(Collection searchAttributes) {
this.searchAttributes = LdapDisplayNameListCopier.copy(searchAttributes);
return this;
}
@Override
@SafeVarargs
public final Builder searchAttributes(String... searchAttributes) {
searchAttributes(Arrays.asList(searchAttributes));
return this;
}
public final String getSearchString() {
return searchString;
}
public final void setSearchString(String searchString) {
this.searchString = searchString;
}
@Override
public final Builder searchString(String searchString) {
this.searchString = searchString;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SearchUsersRequest build() {
return new SearchUsersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy