com.datadog.api.client.v2.model

Class CreateSnapshotDataAttributesRequest

java.lang.Object

com.datadog.api.client.v2.model.CreateSnapshotDataAttributesRequest

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

Attributes for snapshot creation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ADDITIONAL_CONFIG
static String	JSON_PROPERTY_END
static String	JSON_PROPERTY_HEIGHT
static String	JSON_PROPERTY_IS_AUTHENTICATED
static String	JSON_PROPERTY_START
static String	JSON_PROPERTY_TTL
static String	JSON_PROPERTY_WIDGET_DEFINITION
static String	JSON_PROPERTY_WIDTH
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
CreateSnapshotDataAttributesRequest()
CreateSnapshotDataAttributesRequest(Long end, Long start, Map<String,Object> widgetDefinition)

Method Summary

Modifier and Type	Method and Description
CreateSnapshotDataAttributesRequest	additionalConfig(CreateSnapshotAdditionalConfig additionalConfig)
CreateSnapshotDataAttributesRequest	end(Long end)
boolean	equals(Object o) Return true if this CreateSnapshotDataAttributesRequest object is equal to o.
CreateSnapshotAdditionalConfig	getAdditionalConfig() Additional configuration options for snapshot creation.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Long	getEnd() End of the time window for the snapshot, in milliseconds since Unix epoch.
Long	getHeight() The height of the rendered snapshot in pixels.
Boolean	getIsAuthenticated() Whether the snapshot requires authentication to view.
Long	getStart() Start of the time window for the snapshot, in milliseconds since Unix epoch.
CreateSnapshotTTL	getTtl() The time-to-live for the snapshot.
Map<String,Object>	getWidgetDefinition() The widget definition to render as a snapshot.
Long	getWidth() The width of the rendered snapshot in pixels.
int	hashCode()
CreateSnapshotDataAttributesRequest	height(Long height)
CreateSnapshotDataAttributesRequest	isAuthenticated(Boolean isAuthenticated)
CreateSnapshotDataAttributesRequest	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
CreateSnapshotDataAttributesRequest	putWidgetDefinitionItem(String key, Object widgetDefinitionItem)
void	setAdditionalConfig(CreateSnapshotAdditionalConfig additionalConfig)
void	setEnd(Long end)
void	setHeight(Long height)
void	setIsAuthenticated(Boolean isAuthenticated)
void	setStart(Long start)
void	setTtl(CreateSnapshotTTL ttl)
void	setWidgetDefinition(Map<String,Object> widgetDefinition)
void	setWidth(Long width)
CreateSnapshotDataAttributesRequest	start(Long start)
String	toString()
CreateSnapshotDataAttributesRequest	ttl(CreateSnapshotTTL ttl)
CreateSnapshotDataAttributesRequest	widgetDefinition(Map<String,Object> widgetDefinition)
CreateSnapshotDataAttributesRequest	width(Long width)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ADDITIONAL_CONFIG

public static final String JSON_PROPERTY_ADDITIONAL_CONFIG

See Also:

Constant Field Values

JSON_PROPERTY_END

public static final String JSON_PROPERTY_END

See Also:

Constant Field Values

JSON_PROPERTY_HEIGHT

public static final String JSON_PROPERTY_HEIGHT

See Also:

Constant Field Values

JSON_PROPERTY_IS_AUTHENTICATED

public static final String JSON_PROPERTY_IS_AUTHENTICATED

See Also:

Constant Field Values

JSON_PROPERTY_START

public static final String JSON_PROPERTY_START

See Also:

Constant Field Values

JSON_PROPERTY_TTL

public static final String JSON_PROPERTY_TTL

See Also:

Constant Field Values

JSON_PROPERTY_WIDGET_DEFINITION

public static final String JSON_PROPERTY_WIDGET_DEFINITION

See Also:

Constant Field Values

JSON_PROPERTY_WIDTH

public static final String JSON_PROPERTY_WIDTH

See Also:

Constant Field Values

Constructor Detail

CreateSnapshotDataAttributesRequest

public CreateSnapshotDataAttributesRequest()

CreateSnapshotDataAttributesRequest

public CreateSnapshotDataAttributesRequest(Long end,
                                           Long start,
                                           Map<String,Object> widgetDefinition)

Method Detail

additionalConfig

public CreateSnapshotDataAttributesRequest additionalConfig(CreateSnapshotAdditionalConfig additionalConfig)

getAdditionalConfig

@Nullable
public CreateSnapshotAdditionalConfig getAdditionalConfig()

Additional configuration options for snapshot creation.

Returns:

additionalConfig

setAdditionalConfig

public void setAdditionalConfig(CreateSnapshotAdditionalConfig additionalConfig)

end

public CreateSnapshotDataAttributesRequest end(Long end)

getEnd

public Long getEnd()

End of the time window for the snapshot, in milliseconds since Unix epoch.

Returns:

end

setEnd

public void setEnd(Long end)

height

public CreateSnapshotDataAttributesRequest height(Long height)

getHeight

@Nullable
public Long getHeight()

The height of the rendered snapshot in pixels.

Returns:

height

setHeight

public void setHeight(Long height)

isAuthenticated

public CreateSnapshotDataAttributesRequest isAuthenticated(Boolean isAuthenticated)

getIsAuthenticated

@Nullable
public Boolean getIsAuthenticated()

Whether the snapshot requires authentication to view. Authenticated snapshots are scoped to the creating organization.

Returns:

isAuthenticated

setIsAuthenticated

public void setIsAuthenticated(Boolean isAuthenticated)

start

public CreateSnapshotDataAttributesRequest start(Long start)

getStart

public Long getStart()

Start of the time window for the snapshot, in milliseconds since Unix epoch.

Returns:

start

setStart

public void setStart(Long start)

ttl

public CreateSnapshotDataAttributesRequest ttl(CreateSnapshotTTL ttl)

getTtl

@Nullable
public CreateSnapshotTTL getTtl()

The time-to-live for the snapshot. This value corresponds to storage lifecycle policies that automatically delete the snapshot after the specified period.

Returns:

ttl

setTtl

public void setTtl(CreateSnapshotTTL ttl)

widgetDefinition

public CreateSnapshotDataAttributesRequest widgetDefinition(Map<String,Object> widgetDefinition)

putWidgetDefinitionItem

public CreateSnapshotDataAttributesRequest putWidgetDefinitionItem(String key,
                                                                   Object widgetDefinitionItem)

getWidgetDefinition

public Map<String,Object> getWidgetDefinition()

The widget definition to render as a snapshot. Must include a valid type field and non-empty requests array.

Returns:

widgetDefinition

setWidgetDefinition

public void setWidgetDefinition(Map<String,Object> widgetDefinition)

width

public CreateSnapshotDataAttributesRequest width(Long width)

getWidth

@Nullable
public Long getWidth()

The width of the rendered snapshot in pixels.

Returns:

width

setWidth

public void setWidth(Long width)

putAdditionalProperty

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

CreateSnapshotDataAttributesRequest

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