Class SearchGroupsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.directoryservicedata.model.DirectoryServiceDataRequest
software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchGroupsRequest extends DirectoryServiceDataRequest implements ToCopyableBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>

  • Method Details

    • directoryId

      public final String directoryId()

      The identifier (ID) of the directory that's associated with the group.

      Returns:
      The identifier (ID) of the directory that's associated with the group.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to be returned per request.

      Returns:
      The maximum number of results to be returned per request.

    • nextToken

      public final String nextToken()

      An encoded paging token for paginated calls that can be passed back to retrieve the next page.

      Returns:
      An encoded paging token for paginated calls that can be passed back to retrieve the next page.

    • realm

      public final String realm()

      The domain name that's associated with the group.

      This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

      This value is case insensitive.

      Returns:
      The domain name that's associated with the group.

      This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

      This value is case insensitive.

    • hasSearchAttributes

      public final boolean hasSearchAttributes()
      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 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.

    • searchAttributes

      public final List<String> searchAttributes()

      One or more data attributes that are used to search for a group. 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 hasSearchAttributes() method.

      Returns:
      One or more data attributes that are used to search for a group. For a list of supported attributes, see Directory Service Data Attributes.

    • searchString

      public final String 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.

      Returns:
      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.

    • toBuilder

      public SearchGroupsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>
      Specified by:
      toBuilder in class DirectoryServiceDataRequest
      Returns:
      a builder for type T

    • builder

      public static SearchGroupsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchGroupsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.