DescribeExplainabilityResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.forecast.model.DescribeExplainabilityResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeExplainabilityResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeExplainabilityResult()

Constructors
Constructor and Description
`DescribeExplainabilityResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeExplainabilityResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the Explainability resource was created.
`DataSource`	`getDataSource()`
`Boolean`	`getEnableVisualization()` Whether the visualization was enabled for the Explainability resource.
`String`	`getEndDateTime()` If `TimePointGranularity` is set to `SPECIFIC`, the last time point in the Explainability.
`Long`	`getEstimatedTimeRemainingInMinutes()` The estimated time remaining in minutes for the CreateExplainability job to complete.
`String`	`getExplainabilityArn()` The Amazon Resource Name (ARN) of the Explainability.
`ExplainabilityConfig`	`getExplainabilityConfig()` The configuration settings that define the granularity of time series and time points for the Explainability.
`String`	`getExplainabilityName()` The name of the Explainability.
`Date`	`getLastModificationTime()` The last time the resource was modified.
`String`	`getMessage()` If an error occurred, a message about the error.
`String`	`getResourceArn()` The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
`Schema`	`getSchema()`
`String`	`getStartDateTime()` If `TimePointGranularity` is set to `SPECIFIC`, the first time point in the Explainability.
`String`	`getStatus()` The status of the Explainability resource.
`int`	`hashCode()`
`Boolean`	`isEnableVisualization()` Whether the visualization was enabled for the Explainability resource.
`void`	`setCreationTime(Date creationTime)` When the Explainability resource was created.
`void`	`setDataSource(DataSource dataSource)`
`void`	`setEnableVisualization(Boolean enableVisualization)` Whether the visualization was enabled for the Explainability resource.
`void`	`setEndDateTime(String endDateTime)` If `TimePointGranularity` is set to `SPECIFIC`, the last time point in the Explainability.
`void`	`setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The estimated time remaining in minutes for the CreateExplainability job to complete.
`void`	`setExplainabilityArn(String explainabilityArn)` The Amazon Resource Name (ARN) of the Explainability.
`void`	`setExplainabilityConfig(ExplainabilityConfig explainabilityConfig)` The configuration settings that define the granularity of time series and time points for the Explainability.
`void`	`setExplainabilityName(String explainabilityName)` The name of the Explainability.
`void`	`setLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`void`	`setMessage(String message)` If an error occurred, a message about the error.
`void`	`setResourceArn(String resourceArn)` The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
`void`	`setSchema(Schema schema)`
`void`	`setStartDateTime(String startDateTime)` If `TimePointGranularity` is set to `SPECIFIC`, the first time point in the Explainability.
`void`	`setStatus(String status)` The status of the Explainability resource.
`String`	`toString()` Returns a string representation of this object.
`DescribeExplainabilityResult`	`withCreationTime(Date creationTime)` When the Explainability resource was created.
`DescribeExplainabilityResult`	`withDataSource(DataSource dataSource)`
`DescribeExplainabilityResult`	`withEnableVisualization(Boolean enableVisualization)` Whether the visualization was enabled for the Explainability resource.
`DescribeExplainabilityResult`	`withEndDateTime(String endDateTime)` If `TimePointGranularity` is set to `SPECIFIC`, the last time point in the Explainability.
`DescribeExplainabilityResult`	`withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The estimated time remaining in minutes for the CreateExplainability job to complete.
`DescribeExplainabilityResult`	`withExplainabilityArn(String explainabilityArn)` The Amazon Resource Name (ARN) of the Explainability.
`DescribeExplainabilityResult`	`withExplainabilityConfig(ExplainabilityConfig explainabilityConfig)` The configuration settings that define the granularity of time series and time points for the Explainability.
`DescribeExplainabilityResult`	`withExplainabilityName(String explainabilityName)` The name of the Explainability.
`DescribeExplainabilityResult`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`DescribeExplainabilityResult`	`withMessage(String message)` If an error occurred, a message about the error.
`DescribeExplainabilityResult`	`withResourceArn(String resourceArn)` The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
`DescribeExplainabilityResult`	`withSchema(Schema schema)`
`DescribeExplainabilityResult`	`withStartDateTime(String startDateTime)` If `TimePointGranularity` is set to `SPECIFIC`, the first time point in the Explainability.
`DescribeExplainabilityResult`	`withStatus(String status)` The status of the Explainability resource.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeExplainabilityResult
```
public DescribeExplainabilityResult()
```
- Method Detail
  - setExplainabilityArn
```
public void setExplainabilityArn(String explainabilityArn)
```
    The Amazon Resource Name (ARN) of the Explainability.
    
    Parameters:
    
    explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.
  - getExplainabilityArn
```
public String getExplainabilityArn()
```
    The Amazon Resource Name (ARN) of the Explainability.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Explainability.
  - withExplainabilityArn
```
public DescribeExplainabilityResult withExplainabilityArn(String explainabilityArn)
```
    The Amazon Resource Name (ARN) of the Explainability.
    
    Parameters:
    
    explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExplainabilityName
```
public void setExplainabilityName(String explainabilityName)
```
    The name of the Explainability.
    
    Parameters:
    
    explainabilityName - The name of the Explainability.
  - getExplainabilityName
```
public String getExplainabilityName()
```
    The name of the Explainability.
    
    Returns:
    
    The name of the Explainability.
  - withExplainabilityName
```
public DescribeExplainabilityResult withExplainabilityName(String explainabilityName)
```
    The name of the Explainability.
    
    Parameters:
    
    explainabilityName - The name of the Explainability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceArn
```
public void setResourceArn(String resourceArn)
```
    The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
    
    Parameters:
    
    resourceArn - The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
  - getResourceArn
```
public String getResourceArn()
```
    The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
  - withResourceArn
```
public DescribeExplainabilityResult withResourceArn(String resourceArn)
```
    The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
    
    Parameters:
    
    resourceArn - The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExplainabilityConfig
```
public void setExplainabilityConfig(ExplainabilityConfig explainabilityConfig)
```
    The configuration settings that define the granularity of time series and time points for the Explainability.
    
    Parameters:
    
    explainabilityConfig - The configuration settings that define the granularity of time series and time points for the Explainability.
  - getExplainabilityConfig
```
public ExplainabilityConfig getExplainabilityConfig()
```
    The configuration settings that define the granularity of time series and time points for the Explainability.
    
    Returns:
    
    The configuration settings that define the granularity of time series and time points for the Explainability.
  - withExplainabilityConfig
```
public DescribeExplainabilityResult withExplainabilityConfig(ExplainabilityConfig explainabilityConfig)
```
    The configuration settings that define the granularity of time series and time points for the Explainability.
    
    Parameters:
    
    explainabilityConfig - The configuration settings that define the granularity of time series and time points for the Explainability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableVisualization
```
public void setEnableVisualization(Boolean enableVisualization)
```
    Whether the visualization was enabled for the Explainability resource.
    
    Parameters:
    
    enableVisualization - Whether the visualization was enabled for the Explainability resource.
  - getEnableVisualization
```
public Boolean getEnableVisualization()
```
    Whether the visualization was enabled for the Explainability resource.
    
    Returns:
    
    Whether the visualization was enabled for the Explainability resource.
  - withEnableVisualization
```
public DescribeExplainabilityResult withEnableVisualization(Boolean enableVisualization)
```
    Whether the visualization was enabled for the Explainability resource.
    
    Parameters:
    
    enableVisualization - Whether the visualization was enabled for the Explainability resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableVisualization
```
public Boolean isEnableVisualization()
```
    Whether the visualization was enabled for the Explainability resource.
    
    Returns:
    
    Whether the visualization was enabled for the Explainability resource.
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
    Parameters:
    
    dataSource -
  - getDataSource
```
public DataSource getDataSource()
```
    Returns:
  - withDataSource
```
public DescribeExplainabilityResult withDataSource(DataSource dataSource)
```
    Parameters:
    
    dataSource -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchema
```
public void setSchema(Schema schema)
```
    Parameters:
    
    schema -
  - getSchema
```
public Schema getSchema()
```
    Returns:
  - withSchema
```
public DescribeExplainabilityResult withSchema(Schema schema)
```
    Parameters:
    
    schema -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartDateTime
```
public void setStartDateTime(String startDateTime)
```
    If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
    
    Parameters:
    
    startDateTime - If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
  - getStartDateTime
```
public String getStartDateTime()
```
    If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
    
    Returns:
    
    If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
  - withStartDateTime
```
public DescribeExplainabilityResult withStartDateTime(String startDateTime)
```
    If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
    
    Parameters:
    
    startDateTime - If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndDateTime
```
public void setEndDateTime(String endDateTime)
```
    If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
    
    Parameters:
    
    endDateTime - If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
  - getEndDateTime
```
public String getEndDateTime()
```
    If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
    
    Returns:
    
    If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
  - withEndDateTime
```
public DescribeExplainabilityResult withEndDateTime(String endDateTime)
```
    If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
    
    Parameters:
    
    endDateTime - If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEstimatedTimeRemainingInMinutes
```
public void setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The estimated time remaining in minutes for the CreateExplainability job to complete.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the CreateExplainability job to complete.
  - getEstimatedTimeRemainingInMinutes
```
public Long getEstimatedTimeRemainingInMinutes()
```
    The estimated time remaining in minutes for the CreateExplainability job to complete.
    
    Returns:
    
    The estimated time remaining in minutes for the CreateExplainability job to complete.
  - withEstimatedTimeRemainingInMinutes
```
public DescribeExplainabilityResult withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The estimated time remaining in minutes for the CreateExplainability job to complete.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the CreateExplainability job to complete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessage
```
public void setMessage(String message)
```
    If an error occurred, a message about the error.
    
    Parameters:
    
    message - If an error occurred, a message about the error.
  - getMessage
```
public String getMessage()
```
    If an error occurred, a message about the error.
    
    Returns:
    
    If an error occurred, a message about the error.
  - withMessage
```
public DescribeExplainabilityResult withMessage(String message)
```
    If an error occurred, a message about the error.
    
    Parameters:
    
    message - If an error occurred, a message about the error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the Explainability resource. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    Parameters:
    status - The status of the Explainability resource. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  - getStatus
```
public String getStatus()
```
    The status of the Explainability resource. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    Returns:
    The status of the Explainability resource. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  - withStatus
```
public DescribeExplainabilityResult withStatus(String status)
```
    The status of the Explainability resource. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    Parameters:
    status - The status of the Explainability resource. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    When the Explainability resource was created.
    
    Parameters:
    
    creationTime - When the Explainability resource was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the Explainability resource was created.
    
    Returns:
    
    When the Explainability resource was created.
  - withCreationTime
```
public DescribeExplainabilityResult withCreationTime(Date creationTime)
```
    When the Explainability resource was created.
    
    Parameters:
    
    creationTime - When the Explainability resource was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModificationTime
```
public void setLastModificationTime(Date lastModificationTime)
```
    The last time the resource was modified. The timestamp depends on the status of the job:
    - CREATE_PENDING - The CreationTime.
    - CREATE_IN_PROGRESS - The current timestamp.
    - CREATE_STOPPING - The current timestamp.
    - CREATE_STOPPED - When the job stopped.
    - ACTIVE or CREATE_FAILED - When the job finished or failed.
    Parameters:
    lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:
    
    CREATE_PENDING - The CreationTime.
    
    CREATE_IN_PROGRESS - The current timestamp.
    
    CREATE_STOPPING - The current timestamp.
    
    CREATE_STOPPED - When the job stopped.
    
    ACTIVE or CREATE_FAILED - When the job finished or failed.
  - getLastModificationTime
```
public Date getLastModificationTime()
```
    The last time the resource was modified. The timestamp depends on the status of the job:
    - CREATE_PENDING - The CreationTime.
    - CREATE_IN_PROGRESS - The current timestamp.
    - CREATE_STOPPING - The current timestamp.
    - CREATE_STOPPED - When the job stopped.
    - ACTIVE or CREATE_FAILED - When the job finished or failed.
    Returns:
    The last time the resource was modified. The timestamp depends on the status of the job:
    
    CREATE_PENDING - The CreationTime.
    
    CREATE_IN_PROGRESS - The current timestamp.
    
    CREATE_STOPPING - The current timestamp.
    
    CREATE_STOPPED - When the job stopped.
    
    ACTIVE or CREATE_FAILED - When the job finished or failed.
  - withLastModificationTime
```
public DescribeExplainabilityResult withLastModificationTime(Date lastModificationTime)
```
    The last time the resource was modified. The timestamp depends on the status of the job:
    - CREATE_PENDING - The CreationTime.
    - CREATE_IN_PROGRESS - The current timestamp.
    - CREATE_STOPPING - The current timestamp.
    - CREATE_STOPPED - When the job stopped.
    - ACTIVE or CREATE_FAILED - When the job finished or failed.
    Parameters:
    lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:
    
    CREATE_PENDING - The CreationTime.
    
    CREATE_IN_PROGRESS - The current timestamp.
    
    CREATE_STOPPING - The current timestamp.
    
    CREATE_STOPPED - When the job stopped.
    
    ACTIVE or CREATE_FAILED - When the job finished or failed.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeExplainabilityResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class DescribeExplainabilityResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeExplainabilityResult

Method Detail

setExplainabilityArn

getExplainabilityArn

withExplainabilityArn

setExplainabilityName

getExplainabilityName

withExplainabilityName

setResourceArn

getResourceArn

withResourceArn

setExplainabilityConfig

getExplainabilityConfig

withExplainabilityConfig

setEnableVisualization

getEnableVisualization

withEnableVisualization

isEnableVisualization

setDataSource

getDataSource

withDataSource

setSchema

getSchema

withSchema

setStartDateTime

getStartDateTime

withStartDateTime

setEndDateTime

getEndDateTime

withEndDateTime

setEstimatedTimeRemainingInMinutes

getEstimatedTimeRemainingInMinutes

withEstimatedTimeRemainingInMinutes

setMessage

getMessage

withMessage

setStatus

getStatus

withStatus

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

toString

equals

hashCode

clone