com.datadog.api.client.v2.model

Class GovernanceControlParameterDefinition

java.lang.Object

com.datadog.api.client.v2.model.GovernanceControlParameterDefinition

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class GovernanceControlParameterDefinition
extends Object

The definition of a configurable parameter on a control or mitigation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DEFAULT_VALUE
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_DISPLAY_NAME
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_REQUIRED
static String	JSON_PROPERTY_SUPPORTED_VALUES
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
GovernanceControlParameterDefinition()
GovernanceControlParameterDefinition(Object defaultValue, String description, String displayName, String name, Boolean required, List<GovernanceControlSupportedValue> supportedValues, String type)

Method Summary

Modifier and Type	Method and Description
GovernanceControlParameterDefinition	addSupportedValuesItem(GovernanceControlSupportedValue supportedValuesItem)
GovernanceControlParameterDefinition	defaultValue(Object defaultValue)
GovernanceControlParameterDefinition	description(String description)
GovernanceControlParameterDefinition	displayName(String displayName)
boolean	equals(Object o) Return true if this GovernanceControlParameterDefinition object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Object	getDefaultValue() The default value of the parameter.
String	getDescription() A human-readable description of the parameter.
String	getDisplayName() The human-readable name of the parameter.
String	getName() The machine-readable name of the parameter.
Boolean	getRequired() Whether the parameter must be provided.
List<GovernanceControlSupportedValue>	getSupportedValues() The supported values for an enumerated parameter.
String	getType() The type of the parameter, such as integer, string, boolean , enum, or pattern_list.
int	hashCode()
GovernanceControlParameterDefinition	name(String name)
GovernanceControlParameterDefinition	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
GovernanceControlParameterDefinition	required(Boolean required)
void	setDefaultValue(Object defaultValue)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setName(String name)
void	setRequired(Boolean required)
void	setSupportedValues(List<GovernanceControlSupportedValue> supportedValues)
void	setType(String type)
GovernanceControlParameterDefinition	supportedValues(List<GovernanceControlSupportedValue> supportedValues)
String	toString()
GovernanceControlParameterDefinition	type(String type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_DEFAULT_VALUE

public static final String JSON_PROPERTY_DEFAULT_VALUE

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_DISPLAY_NAME

public static final String JSON_PROPERTY_DISPLAY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_REQUIRED

public static final String JSON_PROPERTY_REQUIRED

See Also:

Constant Field Values

JSON_PROPERTY_SUPPORTED_VALUES

public static final String JSON_PROPERTY_SUPPORTED_VALUES

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

GovernanceControlParameterDefinition

public GovernanceControlParameterDefinition()

GovernanceControlParameterDefinition

public GovernanceControlParameterDefinition(Object defaultValue,
                                            String description,
                                            String displayName,
                                            String name,
                                            Boolean required,
                                            List<GovernanceControlSupportedValue> supportedValues,
                                            String type)

Method Detail

defaultValue

public GovernanceControlParameterDefinition defaultValue(Object defaultValue)

getDefaultValue

public Object getDefaultValue()

The default value of the parameter. The JSON type depends on the parameter's type.

Returns:

defaultValue

setDefaultValue

public void setDefaultValue(Object defaultValue)

description

public GovernanceControlParameterDefinition description(String description)

getDescription

public String getDescription()

A human-readable description of the parameter.

Returns:

description

setDescription

public void setDescription(String description)

displayName

public GovernanceControlParameterDefinition displayName(String displayName)

getDisplayName

public String getDisplayName()

The human-readable name of the parameter.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

name

public GovernanceControlParameterDefinition name(String name)

getName

public String getName()

The machine-readable name of the parameter.

Returns:

name

setName

public void setName(String name)

required

public GovernanceControlParameterDefinition required(Boolean required)

getRequired

public Boolean getRequired()

Whether the parameter must be provided.

Returns:

required

setRequired

public void setRequired(Boolean required)

supportedValues

public GovernanceControlParameterDefinition supportedValues(List<GovernanceControlSupportedValue> supportedValues)

addSupportedValuesItem

public GovernanceControlParameterDefinition addSupportedValuesItem(GovernanceControlSupportedValue supportedValuesItem)

getSupportedValues

@Nullable
public List<GovernanceControlSupportedValue> getSupportedValues()

The supported values for an enumerated parameter. null when the parameter is not an enumerated type.

Returns:

supportedValues

setSupportedValues

public void setSupportedValues(List<GovernanceControlSupportedValue> supportedValues)

type

public GovernanceControlParameterDefinition type(String type)

getType

public String getType()

The type of the parameter, such as integer, string, boolean , enum, or pattern_list.

Returns:

type

setType

public void setType(String type)

putAdditionalProperty

public GovernanceControlParameterDefinition putAdditionalProperty(String key,
                                                                  Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

GovernanceControlParameterDefinition

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this GovernanceControlParameterDefinition object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object