software.amazon.awssdk.services.braket.model

Class JobSummary

java.lang.Object

software.amazon.awssdk.services.braket.model.JobSummary

All Implemented Interfaces:

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

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

Provides summary information about an Amazon Braket job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobSummary.Builder

Method Summary

Modifier and Type	Method and Description
static JobSummary.Builder	builder()
Instant	createdAt() The date and time that the Amazon Braket job was created.
String	device() Provides summary information about the primary device used by an Amazon Braket job.
Instant	endedAt() The date and time that the Amazon Braket job ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	jobArn() The ARN of the Amazon Braket job.
String	jobName() The name of the Amazon Braket job.
List<SdkField<?>>	sdkFields()
static Class<? extends JobSummary.Builder>	serializableBuilderClass()
Instant	startedAt() The date and time that the Amazon Braket job was started.
JobPrimaryStatus	status() The status of the Amazon Braket job.
String	statusAsString() The status of the Amazon Braket job.
Map<String,String>	tags() A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
JobSummary.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

createdAt

public final Instant createdAt()

The date and time that the Amazon Braket job was created.

Returns:

The date and time that the Amazon Braket job was created.

device

public final String device()

Provides summary information about the primary device used by an Amazon Braket job.

Returns:

Provides summary information about the primary device used by an Amazon Braket job.

endedAt

public final Instant endedAt()

The date and time that the Amazon Braket job ended.

Returns:

The date and time that the Amazon Braket job ended.

jobArn

public final String jobArn()

The ARN of the Amazon Braket job.

Returns:

The ARN of the Amazon Braket job.

jobName

public final String jobName()

The name of the Amazon Braket job.

Returns:

The name of the Amazon Braket job.

startedAt

public final Instant startedAt()

The date and time that the Amazon Braket job was started.

Returns:

The date and time that the Amazon Braket job was started.

status

public final JobPrimaryStatus status()

The status of the Amazon Braket job.

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

Returns:

The status of the Amazon Braket job.

See Also:

JobPrimaryStatus

statusAsString

public final String statusAsString()

The status of the Amazon Braket job.

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

Returns:

The status of the Amazon Braket job.

See Also:

JobPrimaryStatus

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

toBuilder

public JobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobSummary.Builder,JobSummary>

builder

public static JobSummary.Builder builder()

serializableBuilderClass

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