@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AuthParameter extends Object implements Serializable, Cloneable, StructuredPojo
Information about required authentication parameters.
Constructor and Description |
---|
AuthParameter() |
Modifier and Type | Method and Description |
---|---|
AuthParameter |
clone() |
boolean |
equals(Object obj) |
List<String> |
getConnectorSuppliedValues()
Contains default values for this authentication parameter that are supplied by the connector.
|
String |
getDescription()
A description about the authentication parameter.
|
Boolean |
getIsRequired()
Indicates whether this authentication parameter is required.
|
Boolean |
getIsSensitiveField()
Indicates whether this authentication parameter is a sensitive field.
|
String |
getKey()
The authentication key required to authenticate with the connector.
|
String |
getLabel()
Label used for authentication parameter.
|
int |
hashCode() |
Boolean |
isRequired()
Indicates whether this authentication parameter is required.
|
Boolean |
isSensitiveField()
Indicates whether this authentication parameter is a sensitive field.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setConnectorSuppliedValues(Collection<String> connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
|
void |
setDescription(String description)
A description about the authentication parameter.
|
void |
setIsRequired(Boolean isRequired)
Indicates whether this authentication parameter is required.
|
void |
setIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication parameter is a sensitive field.
|
void |
setKey(String key)
The authentication key required to authenticate with the connector.
|
void |
setLabel(String label)
Label used for authentication parameter.
|
String |
toString()
Returns a string representation of this object.
|
AuthParameter |
withConnectorSuppliedValues(Collection<String> connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
|
AuthParameter |
withConnectorSuppliedValues(String... connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
|
AuthParameter |
withDescription(String description)
A description about the authentication parameter.
|
AuthParameter |
withIsRequired(Boolean isRequired)
Indicates whether this authentication parameter is required.
|
AuthParameter |
withIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication parameter is a sensitive field.
|
AuthParameter |
withKey(String key)
The authentication key required to authenticate with the connector.
|
AuthParameter |
withLabel(String label)
Label used for authentication parameter.
|
public void setKey(String key)
The authentication key required to authenticate with the connector.
key
- The authentication key required to authenticate with the connector.public String getKey()
The authentication key required to authenticate with the connector.
public AuthParameter withKey(String key)
The authentication key required to authenticate with the connector.
key
- The authentication key required to authenticate with the connector.public void setIsRequired(Boolean isRequired)
Indicates whether this authentication parameter is required.
isRequired
- Indicates whether this authentication parameter is required.public Boolean getIsRequired()
Indicates whether this authentication parameter is required.
public AuthParameter withIsRequired(Boolean isRequired)
Indicates whether this authentication parameter is required.
isRequired
- Indicates whether this authentication parameter is required.public Boolean isRequired()
Indicates whether this authentication parameter is required.
public void setLabel(String label)
Label used for authentication parameter.
label
- Label used for authentication parameter.public String getLabel()
Label used for authentication parameter.
public AuthParameter withLabel(String label)
Label used for authentication parameter.
label
- Label used for authentication parameter.public void setDescription(String description)
A description about the authentication parameter.
description
- A description about the authentication parameter.public String getDescription()
A description about the authentication parameter.
public AuthParameter withDescription(String description)
A description about the authentication parameter.
description
- A description about the authentication parameter.public void setIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication parameter is a sensitive field.
isSensitiveField
- Indicates whether this authentication parameter is a sensitive field.public Boolean getIsSensitiveField()
Indicates whether this authentication parameter is a sensitive field.
public AuthParameter withIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication parameter is a sensitive field.
isSensitiveField
- Indicates whether this authentication parameter is a sensitive field.public Boolean isSensitiveField()
Indicates whether this authentication parameter is a sensitive field.
public List<String> getConnectorSuppliedValues()
Contains default values for this authentication parameter that are supplied by the connector.
public void setConnectorSuppliedValues(Collection<String> connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
connectorSuppliedValues
- Contains default values for this authentication parameter that are supplied by the connector.public AuthParameter withConnectorSuppliedValues(String... connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
NOTE: This method appends the values to the existing list (if any). Use
setConnectorSuppliedValues(java.util.Collection)
or
withConnectorSuppliedValues(java.util.Collection)
if you want to override the existing values.
connectorSuppliedValues
- Contains default values for this authentication parameter that are supplied by the connector.public AuthParameter withConnectorSuppliedValues(Collection<String> connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
connectorSuppliedValues
- Contains default values for this authentication parameter that are supplied by the connector.public String toString()
toString
in class Object
Object.toString()
public AuthParameter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.