Class AuthConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AuthConfiguration.Builder,AuthConfiguration>
The authentication configuration for a connection returned by the DescribeConnectionType API.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal PropertyThe type of authentication for a connection.A map of key-value pairs for the OAuth2 properties.static AuthConfiguration.Builderbuilder()A map of key-value pairs for the custom authentication properties.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the BasicAuthenticationProperties property.final booleanFor responses, this returns true if the service returned a value for the CustomAuthenticationProperties property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the OAuth2Properties property.A map of key-value pairs for the OAuth2 properties.final PropertyThe Amazon Resource Name (ARN) for the Secrets Manager.static Class<? extends AuthConfiguration.Builder>final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
authenticationType
The type of authentication for a connection.
- Returns:
- The type of authentication for a connection.
-
secretArn
The Amazon Resource Name (ARN) for the Secrets Manager.
- Returns:
- The Amazon Resource Name (ARN) for the Secrets Manager.
-
hasOAuth2Properties
public final boolean hasOAuth2Properties()For responses, this returns true if the service returned a value for the OAuth2Properties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
oAuth2Properties
A map of key-value pairs for the OAuth2 properties. Each value is a a
Propertyobject.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
hasOAuth2Properties()method.- Returns:
- A map of key-value pairs for the OAuth2 properties. Each value is a a
Propertyobject.
-
hasBasicAuthenticationProperties
public final boolean hasBasicAuthenticationProperties()For responses, this returns true if the service returned a value for the BasicAuthenticationProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
basicAuthenticationProperties
A map of key-value pairs for the OAuth2 properties. Each value is a a
Propertyobject.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
hasBasicAuthenticationProperties()method.- Returns:
- A map of key-value pairs for the OAuth2 properties. Each value is a a
Propertyobject.
-
hasCustomAuthenticationProperties
public final boolean hasCustomAuthenticationProperties()For responses, this returns true if the service returned a value for the CustomAuthenticationProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
customAuthenticationProperties
A map of key-value pairs for the custom authentication properties. Each value is a a
Propertyobject.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
hasCustomAuthenticationProperties()method.- Returns:
- A map of key-value pairs for the custom authentication properties. Each value is a a
Propertyobject.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<AuthConfiguration.Builder,AuthConfiguration>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-