@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class OAuth2CustomParameter extends Object implements Serializable, Cloneable, StructuredPojo
Custom parameter required for OAuth 2.0 authentication.
Constructor and Description |
---|
OAuth2CustomParameter() |
Modifier and Type | Method and Description |
---|---|
OAuth2CustomParameter |
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 custom parameter used for OAuth 2.0 authentication.
|
Boolean |
getIsRequired()
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
|
Boolean |
getIsSensitiveField()
Indicates whether this authentication custom parameter is a sensitive field.
|
String |
getKey()
The key of the custom parameter required for OAuth 2.0 authentication.
|
String |
getLabel()
The label of the custom parameter used for OAuth 2.0 authentication.
|
String |
getType()
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
|
int |
hashCode() |
Boolean |
isRequired()
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
|
Boolean |
isSensitiveField()
Indicates whether this authentication custom 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 custom parameter used for OAuth 2.0 authentication.
|
void |
setIsRequired(Boolean isRequired)
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
|
void |
setIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication custom parameter is a sensitive field.
|
void |
setKey(String key)
The key of the custom parameter required for OAuth 2.0 authentication.
|
void |
setLabel(String label)
The label of the custom parameter used for OAuth 2.0 authentication.
|
void |
setType(String type)
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
|
String |
toString()
Returns a string representation of this object.
|
OAuth2CustomParameter |
withConnectorSuppliedValues(Collection<String> connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
|
OAuth2CustomParameter |
withConnectorSuppliedValues(String... connectorSuppliedValues)
Contains default values for this authentication parameter that are supplied by the connector.
|
OAuth2CustomParameter |
withDescription(String description)
A description about the custom parameter used for OAuth 2.0 authentication.
|
OAuth2CustomParameter |
withIsRequired(Boolean isRequired)
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
|
OAuth2CustomParameter |
withIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication custom parameter is a sensitive field.
|
OAuth2CustomParameter |
withKey(String key)
The key of the custom parameter required for OAuth 2.0 authentication.
|
OAuth2CustomParameter |
withLabel(String label)
The label of the custom parameter used for OAuth 2.0 authentication.
|
OAuth2CustomParameter |
withType(OAuth2CustomPropType type)
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
|
OAuth2CustomParameter |
withType(String type)
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
|
public void setKey(String key)
The key of the custom parameter required for OAuth 2.0 authentication.
key
- The key of the custom parameter required for OAuth 2.0 authentication.public String getKey()
The key of the custom parameter required for OAuth 2.0 authentication.
public OAuth2CustomParameter withKey(String key)
The key of the custom parameter required for OAuth 2.0 authentication.
key
- The key of the custom parameter required for OAuth 2.0 authentication.public void setIsRequired(Boolean isRequired)
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
isRequired
- Indicates whether the custom parameter for OAuth 2.0 authentication is required.public Boolean getIsRequired()
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
public OAuth2CustomParameter withIsRequired(Boolean isRequired)
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
isRequired
- Indicates whether the custom parameter for OAuth 2.0 authentication is required.public Boolean isRequired()
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
public void setLabel(String label)
The label of the custom parameter used for OAuth 2.0 authentication.
label
- The label of the custom parameter used for OAuth 2.0 authentication.public String getLabel()
The label of the custom parameter used for OAuth 2.0 authentication.
public OAuth2CustomParameter withLabel(String label)
The label of the custom parameter used for OAuth 2.0 authentication.
label
- The label of the custom parameter used for OAuth 2.0 authentication.public void setDescription(String description)
A description about the custom parameter used for OAuth 2.0 authentication.
description
- A description about the custom parameter used for OAuth 2.0 authentication.public String getDescription()
A description about the custom parameter used for OAuth 2.0 authentication.
public OAuth2CustomParameter withDescription(String description)
A description about the custom parameter used for OAuth 2.0 authentication.
description
- A description about the custom parameter used for OAuth 2.0 authentication.public void setIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication custom parameter is a sensitive field.
isSensitiveField
- Indicates whether this authentication custom parameter is a sensitive field.public Boolean getIsSensitiveField()
Indicates whether this authentication custom parameter is a sensitive field.
public OAuth2CustomParameter withIsSensitiveField(Boolean isSensitiveField)
Indicates whether this authentication custom parameter is a sensitive field.
isSensitiveField
- Indicates whether this authentication custom parameter is a sensitive field.public Boolean isSensitiveField()
Indicates whether this authentication custom 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 OAuth2CustomParameter 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 OAuth2CustomParameter 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 void setType(String type)
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
type
- Indicates whether custom parameter is used with TokenUrl or AuthUrl.OAuth2CustomPropType
public String getType()
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
OAuth2CustomPropType
public OAuth2CustomParameter withType(String type)
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
type
- Indicates whether custom parameter is used with TokenUrl or AuthUrl.OAuth2CustomPropType
public OAuth2CustomParameter withType(OAuth2CustomPropType type)
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
type
- Indicates whether custom parameter is used with TokenUrl or AuthUrl.OAuth2CustomPropType
public String toString()
toString
in class Object
Object.toString()
public OAuth2CustomParameter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.