Class CanaryRunStatus
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CanaryRunStatus.Builder,
CanaryRunStatus>
This structure contains the status information about a canary run.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CanaryRunStatus.Builder
builder()
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()
static Class
<? extends CanaryRunStatus.Builder> final CanaryRunState
state()
The current state of the run.final String
The current state of the run.final String
If run of the canary failed, this field contains the reason for the error.final CanaryRunStateReasonCode
If this value isCANARY_FAILURE
, an exception occurred in the canary code.final String
If this value isCANARY_FAILURE
, an exception occurred in the canary code.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
-
state
The current state of the run.
If the service returns an enum value that is not available in the current SDK version,
state
will returnCanaryRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the run.
- See Also:
-
stateAsString
The current state of the run.
If the service returns an enum value that is not available in the current SDK version,
state
will returnCanaryRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the run.
- See Also:
-
stateReason
If run of the canary failed, this field contains the reason for the error.
- Returns:
- If run of the canary failed, this field contains the reason for the error.
-
stateReasonCode
If this value is
CANARY_FAILURE
, an exception occurred in the canary code. If this value isEXECUTION_FAILURE
, an exception occurred in CloudWatch Synthetics.If the service returns an enum value that is not available in the current SDK version,
stateReasonCode
will returnCanaryRunStateReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateReasonCodeAsString()
.- Returns:
- If this value is
CANARY_FAILURE
, an exception occurred in the canary code. If this value isEXECUTION_FAILURE
, an exception occurred in CloudWatch Synthetics. - See Also:
-
stateReasonCodeAsString
If this value is
CANARY_FAILURE
, an exception occurred in the canary code. If this value isEXECUTION_FAILURE
, an exception occurred in CloudWatch Synthetics.If the service returns an enum value that is not available in the current SDK version,
stateReasonCode
will returnCanaryRunStateReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateReasonCodeAsString()
.- Returns:
- If this value is
CANARY_FAILURE
, an exception occurred in the canary code. If this value isEXECUTION_FAILURE
, an exception occurred in CloudWatch Synthetics. - See Also:
-
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<CanaryRunStatus.Builder,
CanaryRunStatus> - 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
-