Package software.amazon.awssdk.services.iam.model

Class GetSamlProviderResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iam.model.IamResponse
software.amazon.awssdk.services.iam.model.GetSamlProviderResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSamlProviderResponse.Builder,GetSamlProviderResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetSamlProviderResponse extends IamResponse implements ToCopyableBuilder<GetSamlProviderResponse.Builder,GetSamlProviderResponse>

Contains the response to a successful GetSAMLProvider request.

  • Method Details

    • samlProviderUUID

      public final String samlProviderUUID()

      The unique identifier assigned to the SAML provider.

      Returns:
      The unique identifier assigned to the SAML provider.

    • samlMetadataDocument

      public final String samlMetadataDocument()

      The XML metadata document that includes information about an identity provider.

      Returns:
      The XML metadata document that includes information about an identity provider.

    • createDate

      public final Instant createDate()

      The date and time when the SAML provider was created.

      Returns:
      The date and time when the SAML provider was created.

    • validUntil

      public final Instant validUntil()

      The expiration date and time for the SAML provider.

      Returns:
      The expiration date and time for the SAML provider.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

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

      Returns:
      A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

    • assertionEncryptionMode

      public final AssertionEncryptionModeType assertionEncryptionMode()

      Specifies the encryption setting for the SAML provider.

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

      Returns:
      Specifies the encryption setting for the SAML provider.
      See Also:

    • assertionEncryptionModeAsString

      public final String assertionEncryptionModeAsString()

      Specifies the encryption setting for the SAML provider.

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

      Returns:
      Specifies the encryption setting for the SAML provider.
      See Also:

    • hasPrivateKeyList

      public final boolean hasPrivateKeyList()
      For responses, this returns true if the service returned a value for the PrivateKeyList 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.

    • privateKeyList

      public final List<SAMLPrivateKey> privateKeyList()

      The private key metadata for the SAML provider.

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

      Returns:
      The private key metadata for the SAML provider.

    • toBuilder

      public GetSamlProviderResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSamlProviderResponse.Builder,GetSamlProviderResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetSamlProviderResponse.Builder builder()

    • serializableBuilderClass

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