software.amazon.awssdk.services.forecast.model

Class PredictorSummary

java.lang.Object

software.amazon.awssdk.services.forecast.model.PredictorSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PredictorSummary.Builder,PredictorSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class PredictorSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PredictorSummary.Builder,PredictorSummary>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PredictorSummary.Builder

Method Summary

Modifier and Type	Method and Description
static PredictorSummary.Builder	builder()
Instant	creationTime() When the model training task was created.
String	datasetGroupArn() The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModificationTime() Initially, the same as CreationTime (status is CREATE_PENDING).
String	message() If an error occurred, an informational message about the error.
String	predictorArn() The ARN of the predictor.
String	predictorName() The name of the predictor.
List<SdkField<?>>	sdkFields()
static Class<? extends PredictorSummary.Builder>	serializableBuilderClass()
String	status() The status of the predictor.
PredictorSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

predictorArn

public String predictorArn()

The ARN of the predictor.

Returns:

The ARN of the predictor.

predictorName

public String predictorName()

The name of the predictor.

Returns:

The name of the predictor.

datasetGroupArn

public String datasetGroupArn()

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.

status

public String status()

The status of the predictor. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

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

• UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

message

public String message()

If an error occurred, an informational message about the error.

Returns:

If an error occurred, an informational message about the error.

creationTime

public Instant creationTime()

When the model training task was created.

Returns:

When the model training task was created.

lastModificationTime

public Instant lastModificationTime()

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

Returns:

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

toBuilder

public PredictorSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictorSummary.Builder,PredictorSummary>

builder

public static PredictorSummary.Builder builder()

serializableBuilderClass

public static Class<? extends PredictorSummary.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo