ValidationFailure (CDAP ETL App Template API 6.5.0 API)

java.lang.Object
- io.cdap.cdap.etl.api.validation.ValidationFailure

```
@Beta
public class ValidationFailure
extends Object
```
Represents a failure condition occurred during validation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ValidationFailure.Cause
Represents a cause of a failure.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ValidationFailure.Cause` Represents a cause of a failure.

Constructor Summary

Constructors
Constructor and Description
`ValidationFailure(String message)` Creates a validation failure with provided message.
`ValidationFailure(String message, String correctiveAction)` Creates a validation failure with provided message and corrective action.
`ValidationFailure(String message, String correctiveAction, String stageName, Map<String,io.cdap.cdap.api.data.schema.Schema> inputSchemas)` Creates a validation failure with provided message and corrective action.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`List<ValidationFailure.Cause>`	`getCauses()` Returns causes that caused this failure.
`String`	`getCorrectiveAction()` Returns corrective action for this failure.
`String`	`getFullMessage()` Returns failure message along with corrective action.
`String`	`getMessage()` Returns failure message.
`int`	`hashCode()`
`ValidationFailure`	`withCause(ValidationFailure.Cause cause)` Adds provided cause to this validation failure.
`ValidationFailure`	`withConfigElement(String stageConfigProperty, String element)` Adds cause attributes for failure cause that represents an invalid element in the list associated with given stage configure property.
`ValidationFailure`	`withConfigProperty(String stageConfigProperty)` Adds cause attributes that represents invalid stage configure property failure cause.
`ValidationFailure`	`withInputSchemaField(String fieldName)` Adds cause attributes that represents invalid input schema field failure cause.
`ValidationFailure`	`withInputSchemaField(String fieldName, String inputStage)` Adds cause attributes that represents invalid input schema field failure cause.
`ValidationFailure`	`withOutputSchemaField(String fieldName)` Adds cause attributes that represents invalid output schema field failure cause.
`ValidationFailure`	`withOutputSchemaField(String fieldName, String outputPort)` Adds cause attributes that represents invalid output schema field failure cause.
`ValidationFailure`	`withPluginNotFound(String pluginId, String pluginName, String pluginType)` Adds cause attributes that represents plugin not found failure cause.
`ValidationFailure`	`withPluginNotFound(String pluginId, String pluginName, String pluginType, ArtifactId requestedArtifact, ArtifactId suggestedArtifact)` Adds cause attributes that represents plugin not found failure cause.
`ValidationFailure`	`withStacktrace(StackTraceElement[] stacktraceElements)` Adds cause attributes that represents a stacktrace.

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

- Constructor Detail
  - ValidationFailure
```
public ValidationFailure(String message)
```
    Creates a validation failure with provided message.
    
    Parameters:
    
    message - validation failure message
  - ValidationFailure
```
public ValidationFailure(String message,
                         @Nullable
                         String correctiveAction)
```
    Creates a validation failure with provided message and corrective action.
    
    Parameters:
    
    message - validation failure message
    
    correctiveAction - corrective action
  - ValidationFailure
```
public ValidationFailure(String message,
                         @Nullable
                         String correctiveAction,
                         @Nullable
                         String stageName,
                         Map<String,io.cdap.cdap.api.data.schema.Schema> inputSchemas)
```
    Creates a validation failure with provided message and corrective action.
    
    Parameters:
    
    message - validation failure message
    
    correctiveAction - corrective action
    
    stageName - stage name
    
    inputSchemas - map of stage name to input schemas
- Method Detail
  - withCause
```
public ValidationFailure withCause(ValidationFailure.Cause cause)
```
    Adds provided cause to this validation failure.
    
    Parameters:
    
    cause - cause of validation failure
    
    Returns:
    
    validation failure with provided cause
  - withPluginNotFound
```
public ValidationFailure withPluginNotFound(String pluginId,
                                            String pluginName,
                                            String pluginType)
```
    Adds cause attributes that represents plugin not found failure cause.
    
    Parameters:
    
    pluginId - plugin id
    
    pluginName - plugin name
    
    pluginType - plugin type
    
    Returns:
    
    validation failure with plugin not found cause
  - withPluginNotFound
```
public ValidationFailure withPluginNotFound(String pluginId,
                                            String pluginName,
                                            String pluginType,
                                            @Nullable
                                            ArtifactId requestedArtifact,
                                            @Nullable
                                            ArtifactId suggestedArtifact)
```
    Adds cause attributes that represents plugin not found failure cause.
    
    Parameters:
    
    pluginId - plugin id
    
    pluginName - plugin name
    
    pluginType - plugin type
    
    requestedArtifact - requested artifact
    
    suggestedArtifact - suggested artifact
    
    Returns:
    
    validation failure with plugin not found cause
  - withConfigProperty
```
public ValidationFailure withConfigProperty(String stageConfigProperty)
```
    Adds cause attributes that represents invalid stage configure property failure cause.
    
    Parameters:
    
    stageConfigProperty - stage config property
    
    Returns:
    
    validation failure with invalid stage config property cause
  - withConfigElement
```
public ValidationFailure withConfigElement(String stageConfigProperty,
                                           String element)
```
    Adds cause attributes for failure cause that represents an invalid element in the list associated with given stage configure property.
    
    Parameters:
    
    stageConfigProperty - stage config property
    
    element - element in the list associated by a given stageConfigProperty
    
    Returns:
    
    validation failure with invalid stage config property element cause
  - withInputSchemaField
```
public ValidationFailure withInputSchemaField(String fieldName,
                                              @Nullable
                                              String inputStage)
```
    Adds cause attributes that represents invalid input schema field failure cause.
    
    Parameters:
    
    fieldName - name of the input schema field
    
    inputStage - stage name
    
    Returns:
    
    validation failure with invalid input schema field cause
  - withInputSchemaField
```
public ValidationFailure withInputSchemaField(String fieldName)
```
    Adds cause attributes that represents invalid input schema field failure cause.
    
    Parameters:
    
    fieldName - name of the input schema field
    
    Returns:
    
    validation failure with invalid input schema field cause
  - withOutputSchemaField
```
public ValidationFailure withOutputSchemaField(String fieldName,
                                               @Nullable
                                               String outputPort)
```
    Adds cause attributes that represents invalid output schema field failure cause.
    
    Parameters:
    
    fieldName - name of the output schema field
    
    outputPort - stage name
    
    Returns:
    
    validation failure with invalid output schema field cause
  - withOutputSchemaField
```
public ValidationFailure withOutputSchemaField(String fieldName)
```
    Adds cause attributes that represents invalid output schema field failure cause.
    
    Parameters:
    
    fieldName - name of the output schema field
    
    Returns:
    
    validation failure with invalid output schema field cause
  - withStacktrace
```
public ValidationFailure withStacktrace(StackTraceElement[] stacktraceElements)
```
    Adds cause attributes that represents a stacktrace.
    
    Parameters:
    
    stacktraceElements - stacktrace for the error
    
    Returns:
    
    validation failure with stacktrace
  - getMessage
```
public String getMessage()
```
    Returns failure message.
  - getFullMessage
```
public String getFullMessage()
```
    Returns failure message along with corrective action.
  - getCorrectiveAction
```
@Nullable
public String getCorrectiveAction()
```
    Returns corrective action for this failure.
  - getCauses
```
public List<ValidationFailure.Cause> getCauses()
```
    Returns causes that caused this failure.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ValidationFailure

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ValidationFailure

ValidationFailure

ValidationFailure

Method Detail

withCause

withPluginNotFound

withPluginNotFound

withConfigProperty

withConfigElement

withInputSchemaField

withInputSchemaField

withOutputSchemaField

withOutputSchemaField

withStacktrace

getMessage

getFullMessage

getCorrectiveAction

getCauses

equals

hashCode