PredictorSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.forecast.model.PredictorSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PredictorSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PredictorSummary()

Constructors
Constructor and Description
`PredictorSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PredictorSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the model training task was created.
`String`	`getDatasetGroupArn()` The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
`Date`	`getLastModificationTime()` The last time the resource was modified.
`String`	`getMessage()` If an error occurred, an informational message about the error.
`String`	`getPredictorArn()` The ARN of the predictor.
`String`	`getPredictorName()` The name of the predictor.
`String`	`getStatus()` The status of the predictor.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` When the model training task was created.
`void`	`setDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
`void`	`setLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`void`	`setMessage(String message)` If an error occurred, an informational message about the error.
`void`	`setPredictorArn(String predictorArn)` The ARN of the predictor.
`void`	`setPredictorName(String predictorName)` The name of the predictor.
`void`	`setStatus(String status)` The status of the predictor.
`String`	`toString()` Returns a string representation of this object.
`PredictorSummary`	`withCreationTime(Date creationTime)` When the model training task was created.
`PredictorSummary`	`withDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
`PredictorSummary`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`PredictorSummary`	`withMessage(String message)` If an error occurred, an informational message about the error.
`PredictorSummary`	`withPredictorArn(String predictorArn)` The ARN of the predictor.
`PredictorSummary`	`withPredictorName(String predictorName)` The name of the predictor.
`PredictorSummary`	`withStatus(String status)` The status of the predictor.

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

- Constructor Detail
  - PredictorSummary
```
public PredictorSummary()
```
- Method Detail
  - setPredictorArn
```
public void setPredictorArn(String predictorArn)
```
    The ARN of the predictor.
    
    Parameters:
    
    predictorArn - The ARN of the predictor.
  - getPredictorArn
```
public String getPredictorArn()
```
    The ARN of the predictor.
    
    Returns:
    
    The ARN of the predictor.
  - withPredictorArn
```
public PredictorSummary withPredictorArn(String predictorArn)
```
    The ARN of the predictor.
    
    Parameters:
    
    predictorArn - The ARN of the predictor.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPredictorName
```
public void setPredictorName(String predictorName)
```
    The name of the predictor.
    
    Parameters:
    
    predictorName - The name of the predictor.
  - getPredictorName
```
public String getPredictorName()
```
    The name of the predictor.
    
    Returns:
    
    The name of the predictor.
  - withPredictorName
```
public PredictorSummary withPredictorName(String predictorName)
```
    The name of the predictor.
    
    Parameters:
    
    predictorName - The name of the predictor.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetGroupArn
```
public void setDatasetGroupArn(String datasetGroupArn)
```
    The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
    
    Parameters:
    
    datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
  - getDatasetGroupArn
```
public String getDatasetGroupArn()
```
    The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
  - withDatasetGroupArn
```
public PredictorSummary withDatasetGroupArn(String datasetGroupArn)
```
    The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
    
    Parameters:
    
    datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
    
    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 predictor. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
    Parameters:
    status - The status of the predictor. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
  - getStatus
```
public String getStatus()
```
    The status of the predictor. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
    Returns:
    The status of the predictor. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
  - withStatus
```
public PredictorSummary withStatus(String status)
```
    The status of the predictor. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
    Parameters:
    status - The status of the predictor. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
    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, an informational message about the error.
    
    Parameters:
    
    message - If an error occurred, an informational message about the error.
  - getMessage
```
public String getMessage()
```
    If an error occurred, an informational message about the error.
    
    Returns:
    
    If an error occurred, an informational message about the error.
  - withMessage
```
public PredictorSummary withMessage(String message)
```
    If an error occurred, an informational message about the error.
    
    Parameters:
    
    message - If an error occurred, an informational message about the error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    When the model training task was created.
    
    Parameters:
    
    creationTime - When the model training task was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the model training task was created.
    
    Returns:
    
    When the model training task was created.
  - withCreationTime
```
public PredictorSummary withCreationTime(Date creationTime)
```
    When the model training task was created.
    
    Parameters:
    
    creationTime - When the model training task 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 PredictorSummary 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 PredictorSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PredictorSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PredictorSummary

Method Detail

setPredictorArn

getPredictorArn

withPredictorArn

setPredictorName

getPredictorName

withPredictorName

setDatasetGroupArn

getDatasetGroupArn

withDatasetGroupArn

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

toString

equals

hashCode

clone

marshall