Spec (datadog-api-client 2.42.0 API)

java.lang.Object
- com.datadog.api.client.v2.model.Spec

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

The spec defines what the workflow does.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_ANNOTATIONS`
`static String`	`JSON_PROPERTY_CONNECTION_ENVS`
`static String`	`JSON_PROPERTY_HANDLE`
`static String`	`JSON_PROPERTY_INPUT_SCHEMA`
`static String`	`JSON_PROPERTY_OUTPUT_SCHEMA`
`static String`	`JSON_PROPERTY_STEPS`
`static String`	`JSON_PROPERTY_TRIGGERS`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

Spec()

Constructors
Constructor and Description
`Spec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Spec`	`addAnnotationsItem(Annotation annotationsItem)`
`Spec`	`addConnectionEnvsItem(ConnectionEnv connectionEnvsItem)`
`Spec`	`addStepsItem(Step stepsItem)`
`Spec`	`addTriggersItem(Trigger triggersItem)`
`Spec`	`annotations(List<Annotation> annotations)`
`Spec`	`connectionEnvs(List<ConnectionEnv> connectionEnvs)`
`boolean`	`equals(Object o)` Return true if this Spec 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.
`List<Annotation>`	`getAnnotations()` A list of annotations used in the workflow.
`List<ConnectionEnv>`	`getConnectionEnvs()` A list of connections or connection groups used in the workflow.
`String`	`getHandle()` Unique identifier used to trigger workflows automatically in Datadog.
`InputSchema`	`getInputSchema()` A list of input parameters for the workflow.
`OutputSchema`	`getOutputSchema()` A list of output parameters for the workflow.
`List<Step>`	`getSteps()` A `Step` is a sub-component of a workflow.
`List<Trigger>`	`getTriggers()` The list of triggers that activate this workflow.
`Spec`	`handle(String handle)`
`int`	`hashCode()`
`Spec`	`inputSchema(InputSchema inputSchema)`
`Spec`	`outputSchema(OutputSchema outputSchema)`
`Spec`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`void`	`setAnnotations(List<Annotation> annotations)`
`void`	`setConnectionEnvs(List<ConnectionEnv> connectionEnvs)`
`void`	`setHandle(String handle)`
`void`	`setInputSchema(InputSchema inputSchema)`
`void`	`setOutputSchema(OutputSchema outputSchema)`
`void`	`setSteps(List<Step> steps)`
`void`	`setTriggers(List<Trigger> triggers)`
`Spec`	`steps(List<Step> steps)`
`String`	`toString()`
`Spec`	`triggers(List<Trigger> triggers)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - unparsed
```
public boolean unparsed
```
  - JSON_PROPERTY_ANNOTATIONS
```
public static final String JSON_PROPERTY_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CONNECTION_ENVS
```
public static final String JSON_PROPERTY_CONNECTION_ENVS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HANDLE
```
public static final String JSON_PROPERTY_HANDLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INPUT_SCHEMA
```
public static final String JSON_PROPERTY_INPUT_SCHEMA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OUTPUT_SCHEMA
```
public static final String JSON_PROPERTY_OUTPUT_SCHEMA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STEPS
```
public static final String JSON_PROPERTY_STEPS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRIGGERS
```
public static final String JSON_PROPERTY_TRIGGERS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Spec
```
public Spec()
```
- Method Detail
  - annotations
```
public Spec annotations(List<Annotation> annotations)
```
  - addAnnotationsItem
```
public Spec addAnnotationsItem(Annotation annotationsItem)
```
  - getAnnotations
```
@Nullable
public List<Annotation> getAnnotations()
```
    A list of annotations used in the workflow. These are like sticky notes for your workflow!
    
    Returns:
    
    annotations
  - setAnnotations
```
public void setAnnotations(List<Annotation> annotations)
```
  - connectionEnvs
```
public Spec connectionEnvs(List<ConnectionEnv> connectionEnvs)
```
  - addConnectionEnvsItem
```
public Spec addConnectionEnvsItem(ConnectionEnv connectionEnvsItem)
```
  - getConnectionEnvs
```
@Nullable
public List<ConnectionEnv> getConnectionEnvs()
```
    A list of connections or connection groups used in the workflow.
    
    Returns:
    
    connectionEnvs
  - setConnectionEnvs
```
public void setConnectionEnvs(List<ConnectionEnv> connectionEnvs)
```
  - handle
```
public Spec handle(String handle)
```
  - getHandle
```
@Nullable
public String getHandle()
```
    Unique identifier used to trigger workflows automatically in Datadog.
    
    Returns:
    
    handle
  - setHandle
```
public void setHandle(String handle)
```
  - inputSchema
```
public Spec inputSchema(InputSchema inputSchema)
```
  - getInputSchema
```
@Nullable
public InputSchema getInputSchema()
```
    A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
    
    Returns:
    
    inputSchema
  - setInputSchema
```
public void setInputSchema(InputSchema inputSchema)
```
  - outputSchema
```
public Spec outputSchema(OutputSchema outputSchema)
```
  - getOutputSchema
```
@Nullable
public OutputSchema getOutputSchema()
```
    A list of output parameters for the workflow.
    
    Returns:
    
    outputSchema
  - setOutputSchema
```
public void setOutputSchema(OutputSchema outputSchema)
```
  - steps
```
public Spec steps(List<Step> steps)
```
  - addStepsItem
```
public Spec addStepsItem(Step stepsItem)
```
  - getSteps
```
@Nullable
public List<Step> getSteps()
```
    A Step is a sub-component of a workflow. Each Step performs an action.
    
    Returns:
    
    steps
  - setSteps
```
public void setSteps(List<Step> steps)
```
  - triggers
```
public Spec triggers(List<Trigger> triggers)
```
  - addTriggersItem
```
public Spec addTriggersItem(Trigger triggersItem)
```
  - getTriggers
```
@Nullable
public List<Trigger> getTriggers()
```
    The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
    
    Returns:
    
    triggers
  - setTriggers
```
public void setTriggers(List<Trigger> triggers)
```
  - putAdditionalProperty
```
public Spec 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:
    
    Spec
  - 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 Spec 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

Class Spec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_ANNOTATIONS

JSON_PROPERTY_CONNECTION_ENVS

JSON_PROPERTY_HANDLE

JSON_PROPERTY_INPUT_SCHEMA

JSON_PROPERTY_OUTPUT_SCHEMA

JSON_PROPERTY_STEPS

JSON_PROPERTY_TRIGGERS

Constructor Detail

Spec

Method Detail

annotations

addAnnotationsItem

getAnnotations

setAnnotations

connectionEnvs

addConnectionEnvsItem

getConnectionEnvs

setConnectionEnvs

handle

getHandle

setHandle

inputSchema

getInputSchema

setInputSchema

outputSchema

getOutputSchema

setOutputSchema

steps

addStepsItem

getSteps

setSteps

triggers

addTriggersItem

getTriggers

setTriggers

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString