software.amazon.awssdk.services.iotdeviceadvisor.model

Class GetSuiteRunResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotdeviceadvisor.model.IotDeviceAdvisorResponse

software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSuiteRunResponse.Builder,GetSuiteRunResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSuiteRunResponse
extends IotDeviceAdvisorResponse
implements ToCopyableBuilder<GetSuiteRunResponse.Builder,GetSuiteRunResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSuiteRunResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetSuiteRunResponse.Builder	builder()
Instant	endTime() Date (in Unix epoch time) when the test suite run ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorReason() Error reason for any test suite run failure.
<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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSuiteRunResponse.Builder>	serializableBuilderClass()
Instant	startTime() Date (in Unix epoch time) when the test suite run started.
SuiteRunStatus	status() Status for the test suite run.
String	statusAsString() Status for the test suite run.
String	suiteDefinitionId() Suite definition ID for the test suite run.
String	suiteDefinitionVersion() Suite definition version for the test suite run.
String	suiteRunArn() The ARN of the suite run.
SuiteRunConfiguration	suiteRunConfiguration() Suite run configuration for the test suite run.
String	suiteRunId() Suite run ID for the test suite run.
Map<String,String>	tags() The tags attached to the suite run.
TestResult	testResult() Test results for the test suite run.
GetSuiteRunResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotdeviceadvisor.model.IotDeviceAdvisorResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

suiteDefinitionId

public final String suiteDefinitionId()

Suite definition ID for the test suite run.

Returns:

Suite definition ID for the test suite run.

suiteDefinitionVersion

public final String suiteDefinitionVersion()

Suite definition version for the test suite run.

Returns:

Suite definition version for the test suite run.

suiteRunId

public final String suiteRunId()

Suite run ID for the test suite run.

Returns:

Suite run ID for the test suite run.

suiteRunArn

public final String suiteRunArn()

The ARN of the suite run.

Returns:

The ARN of the suite run.

suiteRunConfiguration

public final SuiteRunConfiguration suiteRunConfiguration()

Suite run configuration for the test suite run.

Returns:

Suite run configuration for the test suite run.

testResult

public final TestResult testResult()

Test results for the test suite run.

Returns:

Test results for the test suite run.

startTime

public final Instant startTime()

Date (in Unix epoch time) when the test suite run started.

Returns:

Date (in Unix epoch time) when the test suite run started.

endTime

public final Instant endTime()

Date (in Unix epoch time) when the test suite run ended.

Returns:

Date (in Unix epoch time) when the test suite run ended.

status

public final SuiteRunStatus status()

Status for the test suite run.

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

Returns:

Status for the test suite run.

See Also:

SuiteRunStatus

statusAsString

public final String statusAsString()

Status for the test suite run.

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

Returns:

Status for the test suite run.

See Also:

SuiteRunStatus

errorReason

public final String errorReason()

Error reason for any test suite run failure.

Returns:

Error reason for any test suite run failure.

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()

The tags attached to the suite run.

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:

The tags attached to the suite run.

toBuilder

public GetSuiteRunResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSuiteRunResponse.Builder,GetSuiteRunResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetSuiteRunResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetSuiteRunResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo