Class PredictorSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PredictorSummary.Builder
builder()
final Instant
When the model training task was created.final String
The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
Whether AutoPredictor was used to create the predictor.final Instant
The last time the resource was modified.final String
message()
If an error occurred, an informational message about the error.final String
The ARN of the predictor.final String
The name of the predictor.A summary of the reference predictor used if the predictor was retrained or upgraded.static Class
<? extends PredictorSummary.Builder> final String
status()
The status of the predictor.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
predictorArn
The ARN of the predictor.
- Returns:
- The ARN of the predictor.
-
predictorName
The name of the predictor.
- Returns:
- The name of the predictor.
-
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
Whether AutoPredictor was used to create the predictor.
- Returns:
- Whether AutoPredictor was used to create the predictor.
-
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
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 beACTIVE
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 beACTIVE
before you can use the predictor to create a forecast. -
-
-
message
If an error occurred, an informational message about the error.
- Returns:
- If an error occurred, an informational message about the error.
-
creationTime
When the model training task was created.
- Returns:
- When the model training task was created.
-
lastModificationTime
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_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
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_FAILED
- When the job finished or failed.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PredictorSummary.Builder,
PredictorSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-