Class JobSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobSummary.Builder,
JobSummary>
Provides summary information about an Amazon Braket job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic JobSummary.Builder
builder()
final Instant
The date and time that the Amazon Braket job was created.final String
device()
Provides summary information about the primary device used by an Amazon Braket job.final Instant
endedAt()
The date and time that the Amazon Braket job ended.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
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
jobArn()
The ARN of the Amazon Braket job.final String
jobName()
The name of the Amazon Braket job.static Class
<? extends JobSummary.Builder> final Instant
The date and time that the Amazon Braket job was started.final JobPrimaryStatus
status()
The status of the Amazon Braket job.final String
The status of the Amazon Braket job.tags()
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.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
-
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
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
The date and time that the Amazon Braket job ended.
- Returns:
- The date and time that the Amazon Braket job ended.
-
jobArn
The ARN of the Amazon Braket job.
- Returns:
- The ARN of the Amazon Braket job.
-
jobName
The name of the Amazon Braket job.
- Returns:
- The name of the Amazon Braket job.
-
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
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 returnJobPrimaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the Amazon Braket job.
- See Also:
-
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 returnJobPrimaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the Amazon Braket job.
- See Also:
-
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 theisEmpty()
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
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
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<JobSummary.Builder,
JobSummary> - 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
-