Class CanaryCodeInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CanaryCodeInput.Builder,
CanaryCodeInput>
Use this structure to input your script code for the canary. This structure contains the Lambda handler with the
location where the canary should start running the script. If the script is stored in an Amazon S3 bucket, the bucket
name, key, and version are also included. If the script was passed into the canary directly, the script code is
contained in the value of Zipfile
.
If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.
-
For Node.js canaries, the folder structure must be
nodejs/node_modules/myCanaryFilename.js
For more information, see Packaging your Node.js canary files -
For Python canaries, the folder structure must be
python/myCanaryFilename.py
orpython/myFolder/myCanaryFilename.py
For more information, see Packaging your Python canary files
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic CanaryCodeInput.Builder
builder()
final List
<Dependency> A list of dependencies that should be 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()
final String
s3Bucket()
If your canary script is located in Amazon S3, specify the bucket name here.final String
s3Key()
The Amazon S3 key of your script.final String
The Amazon S3 version ID of your script.static Class
<? extends CanaryCodeInput.Builder> 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.final SdkBytes
zipFile()
If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
s3Bucket
If your canary script is located in Amazon S3, specify the bucket name here. Do not include
s3://
as the start of the bucket name.- Returns:
- If your canary script is located in Amazon S3, specify the bucket name here. Do not include
s3://
as the start of the bucket name.
-
s3Key
The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects.
- Returns:
- The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects.
-
s3Version
The Amazon S3 version ID of your script.
- Returns:
- The Amazon S3 version ID of your script.
-
zipFile
If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.
For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter.
- Returns:
- If you input your canary script directly into the canary instead of referring to an Amazon S3 location,
the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It
must be smaller than 225 Kb.
For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter.
-
handler
The entry point to use for the source code when running the canary. For canaries that use the
syn-python-selenium-1.0
runtime or asyn-nodejs.puppeteer
runtime earlier thansyn-nodejs.puppeteer-3.4
, the handler must be specified asfileName.handler
. Forsyn-python-selenium-1.1
,syn-nodejs.puppeteer-3.4
, and later runtimes, the handler can be specified asfileName.functionName
, or you can specify a folder where canary scripts reside asfolder/fileName.functionName
.- Returns:
- The entry point to use for the source code when running the canary. For canaries that use the
syn-python-selenium-1.0
runtime or asyn-nodejs.puppeteer
runtime earlier thansyn-nodejs.puppeteer-3.4
, the handler must be specified asfileName.handler
. Forsyn-python-selenium-1.1
,syn-nodejs.puppeteer-3.4
, and later runtimes, the handler can be specified asfileName.functionName
, or you can specify a folder where canary scripts reside asfolder/fileName.functionName
.
-
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 should be used for running this canary. Specify the dependencies 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 should be used for running this canary. Specify the dependencies 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<CanaryCodeInput.Builder,
CanaryCodeInput> - 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.
-