Class CanaryCodeOutput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CanaryCodeOutput.Builder,
CanaryCodeOutput>
This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic CanaryCodeOutput.Builder
builder()
final List
<Dependency> A list of dependencies that are used for running this canary.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 String
handler()
The entry point to use for the source code when running the canary.final boolean
For responses, this returns true if the service returned a value for the Dependencies property.final int
hashCode()
static Class
<? extends CanaryCodeOutput.Builder> final String
The ARN of the Lambda layer where Synthetics stores the canary script 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
-
sourceLocationArn
The ARN of the Lambda layer where Synthetics stores the canary script code.
- Returns:
- The ARN of the Lambda layer where Synthetics stores the canary script code.
-
handler
The entry point to use for the source code when running the canary.
- Returns:
- The entry point to use for the source code when running the canary.
-
hasDependencies
public final boolean hasDependencies()For responses, this returns true if the service returned a value for the Dependencies 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. -
dependencies
A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.
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
hasDependencies()
method.- Returns:
- A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.
-
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<CanaryCodeOutput.Builder,
CanaryCodeOutput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-