com.datadog.api.client.v1.model

Class SyntheticsBrowserVariable

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsBrowserVariable

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

Object defining a variable that can be used in your browser test. See the Recording Steps documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_EXAMPLE
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_PATTERN
static String	JSON_PROPERTY_SECURE
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsBrowserVariable()
SyntheticsBrowserVariable(String name, SyntheticsBrowserVariableType type)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Return true if this SyntheticsBrowserVariable object is equal to o.
SyntheticsBrowserVariable	example(String example)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
String	getExample() Example for the variable.
String	getId() ID for the variable.
String	getName() Name of the variable.
String	getPattern() Pattern of the variable.
Boolean	getSecure() Determines whether or not the browser test variable is obfuscated.
SyntheticsBrowserVariableType	getType() Type of browser test variable.
int	hashCode()
SyntheticsBrowserVariable	id(String id)
SyntheticsBrowserVariable	name(String name)
SyntheticsBrowserVariable	pattern(String pattern)
SyntheticsBrowserVariable	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SyntheticsBrowserVariable	secure(Boolean secure)
void	setExample(String example)
void	setId(String id)
void	setName(String name)
void	setPattern(String pattern)
void	setSecure(Boolean secure)
void	setType(SyntheticsBrowserVariableType type)
String	toString()
SyntheticsBrowserVariable	type(SyntheticsBrowserVariableType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_EXAMPLE

public static final String JSON_PROPERTY_EXAMPLE

See Also:

Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_PATTERN

public static final String JSON_PROPERTY_PATTERN

See Also:

Constant Field Values

JSON_PROPERTY_SECURE

public static final String JSON_PROPERTY_SECURE

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

SyntheticsBrowserVariable

public SyntheticsBrowserVariable()

SyntheticsBrowserVariable

public SyntheticsBrowserVariable(String name,
                                 SyntheticsBrowserVariableType type)

Method Detail

example

public SyntheticsBrowserVariable example(String example)

getExample

@Nullable
public String getExample()

Example for the variable.

Returns:

example

setExample

public void setExample(String example)

id

public SyntheticsBrowserVariable id(String id)

getId

@Nullable
public String getId()

ID for the variable. Global variables require an ID.

Returns:

id

setId

public void setId(String id)

name

public SyntheticsBrowserVariable name(String name)

getName

public String getName()

Name of the variable.

Returns:

name

setName

public void setName(String name)

pattern

public SyntheticsBrowserVariable pattern(String pattern)

getPattern

@Nullable
public String getPattern()

Pattern of the variable.

Returns:

pattern

setPattern

public void setPattern(String pattern)

secure

public SyntheticsBrowserVariable secure(Boolean secure)

getSecure

@Nullable
public Boolean getSecure()

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

Returns:

secure

setSecure

public void setSecure(Boolean secure)

type

public SyntheticsBrowserVariable type(SyntheticsBrowserVariableType type)

getType

public SyntheticsBrowserVariableType getType()

Type of browser test variable.

Returns:

type

setType

public void setType(SyntheticsBrowserVariableType type)

putAdditionalProperty

public SyntheticsBrowserVariable 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:

SyntheticsBrowserVariable

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 SyntheticsBrowserVariable 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