Package 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("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	Description
static interface	PredictorSummary.Builder

Method Summary

Modifier and Type	Method	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()
Boolean	isAutoPredictor()	Whether AutoPredictor was used to create the predictor.
Instant	lastModificationTime()	The last time the resource was modified.
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.
ReferencePredictorSummary	referencePredictorSummary()	A summary of the reference predictor used if the predictor was retrained or upgraded.
Map<String,SdkField<?>>	sdkFieldNameToField()
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 final String predictorArn()

The ARN of the predictor.

Returns:

The ARN of the predictor.

predictorName

public final String predictorName()

The name of the predictor.

Returns:

The name of the predictor.

datasetGroupArn

public final 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.

isAutoPredictor

public final Boolean isAutoPredictor()

Whether AutoPredictor was used to create the predictor.

Returns:

Whether AutoPredictor was used to create the predictor.

referencePredictorSummary

public final ReferencePredictorSummary referencePredictorSummary()

A summary of the reference predictor used if the predictor was retrained or upgraded.

Returns:

A summary of the reference predictor used if the predictor was retrained or upgraded.

status

public final 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.

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.

message

public final 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 final Instant creationTime()

When the model training task was created.

Returns:

When the model training task was created.

lastModificationTime

public final Instant 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:

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.

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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo