software.amazon.awssdk.services.appflow.model

Class AuthParameter

java.lang.Object

software.amazon.awssdk.services.appflow.model.AuthParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AuthParameter.Builder,AuthParameter>

@Generated(value="software.amazon.awssdk:codegen")
public final class AuthParameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AuthParameter.Builder,AuthParameter>

Information about required authentication parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthParameter.Builder

Method Summary

Modifier and Type	Method and Description
static AuthParameter.Builder	builder()
List<String>	connectorSuppliedValues() Contains default values for this authentication parameter that are supplied by the connector.
String	description() A description about the authentication parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConnectorSuppliedValues() For responses, this returns true if the service returned a value for the ConnectorSuppliedValues property.
int	hashCode()
Boolean	isRequired() Indicates whether this authentication parameter is required.
Boolean	isSensitiveField() Indicates whether this authentication parameter is a sensitive field.
String	key() The authentication key required to authenticate with the connector.
String	label() Label used for authentication parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends AuthParameter.Builder>	serializableBuilderClass()
AuthParameter.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public final String key()

The authentication key required to authenticate with the connector.

Returns:

The authentication key required to authenticate with the connector.

isRequired

public final Boolean isRequired()

Indicates whether this authentication parameter is required.

Returns:

Indicates whether this authentication parameter is required.

label

public final String label()

Label used for authentication parameter.

Returns:

Label used for authentication parameter.

description

public final String description()

A description about the authentication parameter.

Returns:

A description about the authentication parameter.

isSensitiveField

public final Boolean isSensitiveField()

Indicates whether this authentication parameter is a sensitive field.

Returns:

Indicates whether this authentication parameter is a sensitive field.

hasConnectorSuppliedValues

public final boolean hasConnectorSuppliedValues()

For responses, this returns true if the service returned a value for the ConnectorSuppliedValues 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.

connectorSuppliedValues

public final List<String> connectorSuppliedValues()

Contains default values for this authentication parameter that are supplied by the connector.

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

Returns:

Contains default values for this authentication parameter that are supplied by the connector.

toBuilder

public AuthParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthParameter.Builder,AuthParameter>

builder

public static AuthParameter.Builder builder()

serializableBuilderClass

public static Class<? extends AuthParameter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo