Class DescribeClientAuthenticationSettingsRequest

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

  • Method Details

    • directoryId

      public final String directoryId()

      The identifier of the directory for which to retrieve information.

      Returns:
      The identifier of the directory for which to retrieve information.

    • type

      public final ClientAuthenticationType type()

      The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

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

      Returns:
      The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

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

      Returns:
      The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.
      See Also:

    • nextToken

      public final String nextToken()

      The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.

      Returns:
      The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.

    • limit

      public final Integer limit()

      The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

      Returns:
      The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

    • toBuilder

      public DescribeClientAuthenticationSettingsRequest.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<DescribeClientAuthenticationSettingsRequest.Builder,DescribeClientAuthenticationSettingsRequest>
      Specified by:
      toBuilder in class DirectoryRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeClientAuthenticationSettingsRequest.Builder builder()

    • serializableBuilderClass

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