Package software.amazon.awssdk.services.personalize.model

Class BatchInferenceJobSummary

java.lang.Object

software.amazon.awssdk.services.personalize.model.BatchInferenceJobSummary

All Implemented Interfaces:

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

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

A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchInferenceJobSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	batchInferenceJobArn()	The Amazon Resource Name (ARN) of the batch inference job.
BatchInferenceJobMode	batchInferenceJobMode()	The job's mode.
String	batchInferenceJobModeAsString()	The job's mode.
static BatchInferenceJobSummary.Builder	builder()
Instant	creationDateTime()	The time at which the batch inference job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	If the batch inference job failed, the reason for the failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobName()	The name of the batch inference job.
Instant	lastUpdatedDateTime()	The time at which the batch inference job was last updated.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchInferenceJobSummary.Builder>	serializableBuilderClass()
String	solutionVersionArn()	The ARN of the solution version used by the batch inference job.
String	status()	The status of the batch inference job.
BatchInferenceJobSummary.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

batchInferenceJobArn

public final String batchInferenceJobArn()

The Amazon Resource Name (ARN) of the batch inference job.

Returns:

The Amazon Resource Name (ARN) of the batch inference job.

jobName

public final String jobName()

The name of the batch inference job.

Returns:

The name of the batch inference job.

status

public final String status()

The status of the batch inference job. The status is one of the following values:

• PENDING

• IN PROGRESS

• ACTIVE

• CREATE FAILED

Returns:

The status of the batch inference job. The status is one of the following values:

• PENDING

• IN PROGRESS

• ACTIVE

• CREATE FAILED

creationDateTime

public final Instant creationDateTime()

The time at which the batch inference job was created.

Returns:

The time at which the batch inference job was created.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The time at which the batch inference job was last updated.

Returns:

The time at which the batch inference job was last updated.

failureReason

public final String failureReason()

If the batch inference job failed, the reason for the failure.

Returns:

If the batch inference job failed, the reason for the failure.

solutionVersionArn

public final String solutionVersionArn()

The ARN of the solution version used by the batch inference job.

Returns:

The ARN of the solution version used by the batch inference job.

batchInferenceJobMode

public final BatchInferenceJobMode batchInferenceJobMode()

The job's mode.

If the service returns an enum value that is not available in the current SDK version, batchInferenceJobMode will return BatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchInferenceJobModeAsString().

Returns:

The job's mode.

See Also:

BatchInferenceJobMode

batchInferenceJobModeAsString

public final String batchInferenceJobModeAsString()

The job's mode.

If the service returns an enum value that is not available in the current SDK version, batchInferenceJobMode will return BatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchInferenceJobModeAsString().

Returns:

The job's mode.

See Also:

BatchInferenceJobMode

toBuilder

public BatchInferenceJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchInferenceJobSummary.Builder,BatchInferenceJobSummary>

builder

public static BatchInferenceJobSummary.Builder builder()

serializableBuilderClass

public static Class<? extends BatchInferenceJobSummary.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