Class AuthenticationConfigurationInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AuthenticationConfigurationInput.Builder,
AuthenticationConfigurationInput>
The authentication configuration of a connection.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationType
The authentication type of a connection.final String
The authentication type of a connection.The basic authentication credentials of a connection.builder()
The custom authentication credentials of a connection.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CustomAuthenticationCredentials property.final int
hashCode()
final String
The KMS key ARN of a connection.final OAuth2Properties
The oAuth2 properties of a connection.final String
The secret ARN of a connection.static Class
<? extends AuthenticationConfigurationInput.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
authenticationType
The authentication type of a connection.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- The authentication type of a connection.
- See Also:
-
authenticationTypeAsString
The authentication type of a connection.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- The authentication type of a connection.
- See Also:
-
basicAuthenticationCredentials
The basic authentication credentials of a connection.
- Returns:
- The basic authentication credentials of a connection.
-
hasCustomAuthenticationCredentials
public final boolean hasCustomAuthenticationCredentials()For responses, this returns true if the service returned a value for the CustomAuthenticationCredentials 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. -
customAuthenticationCredentials
The custom authentication credentials of a connection.
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
hasCustomAuthenticationCredentials()
method.- Returns:
- The custom authentication credentials of a connection.
-
kmsKeyArn
The KMS key ARN of a connection.
- Returns:
- The KMS key ARN of a connection.
-
oAuth2Properties
The oAuth2 properties of a connection.
- Returns:
- The oAuth2 properties of a connection.
-
secretArn
The secret ARN of a connection.
- Returns:
- The secret ARN of a connection.
-
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 interfaceToCopyableBuilder<AuthenticationConfigurationInput.Builder,
AuthenticationConfigurationInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-