CanaryCodeInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.synthetics.model.CanaryCodeInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanaryCodeInput
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CanaryCodeInput()

Constructors
Constructor and Description
`CanaryCodeInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CanaryCodeInput`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getHandler()` The entry point to use for the source code when running the canary.
`String`	`getS3Bucket()` If your canary script is located in S3, specify the bucket name here.
`String`	`getS3Key()` The S3 key of your script.
`String`	`getS3Version()` The S3 version ID of your script.
`ByteBuffer`	`getZipFile()` If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHandler(String handler)` The entry point to use for the source code when running the canary.
`void`	`setS3Bucket(String s3Bucket)` If your canary script is located in S3, specify the bucket name here.
`void`	`setS3Key(String s3Key)` The S3 key of your script.
`void`	`setS3Version(String s3Version)` The S3 version ID of your script.
`void`	`setZipFile(ByteBuffer zipFile)` If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script.
`String`	`toString()` Returns a string representation of this object.
`CanaryCodeInput`	`withHandler(String handler)` The entry point to use for the source code when running the canary.
`CanaryCodeInput`	`withS3Bucket(String s3Bucket)` If your canary script is located in S3, specify the bucket name here.
`CanaryCodeInput`	`withS3Key(String s3Key)` The S3 key of your script.
`CanaryCodeInput`	`withS3Version(String s3Version)` The S3 version ID of your script.
`CanaryCodeInput`	`withZipFile(ByteBuffer zipFile)` If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CanaryCodeInput
```
public CanaryCodeInput()
```
- Method Detail
  - setS3Bucket
```
public void setS3Bucket(String s3Bucket)
```
    If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
    
    Parameters:
    
    s3Bucket - If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
  - getS3Bucket
```
public String getS3Bucket()
```
    If your canary script is located in 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 S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
  - withS3Bucket
```
public CanaryCodeInput withS3Bucket(String s3Bucket)
```
    If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
    
    Parameters:
    
    s3Bucket - If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Key
```
public void setS3Key(String s3Key)
```
    The S3 key of your script. For more information, see Working with Amazon S3 Objects.
    
    Parameters:
    
    s3Key - The S3 key of your script. For more information, see Working with Amazon S3 Objects.
  - getS3Key
```
public String getS3Key()
```
    The S3 key of your script. For more information, see Working with Amazon S3 Objects.
    
    Returns:
    
    The S3 key of your script. For more information, see Working with Amazon S3 Objects.
  - withS3Key
```
public CanaryCodeInput withS3Key(String s3Key)
```
    The S3 key of your script. For more information, see Working with Amazon S3 Objects.
    
    Parameters:
    
    s3Key - The S3 key of your script. For more information, see Working with Amazon S3 Objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Version
```
public void setS3Version(String s3Version)
```
    The S3 version ID of your script.
    
    Parameters:
    
    s3Version - The S3 version ID of your script.
  - getS3Version
```
public String getS3Version()
```
    The S3 version ID of your script.
    
    Returns:
    
    The S3 version ID of your script.
  - withS3Version
```
public CanaryCodeInput withS3Version(String s3Version)
```
    The S3 version ID of your script.
    
    Parameters:
    
    s3Version - The S3 version ID of your script.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setZipFile
```
public void setZipFile(ByteBuffer zipFile)
```
    If you input your canary script directly into the canary instead of referring to an 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 S3 location instead of inputting it directly with this parameter.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    zipFile - If you input your canary script directly into the canary instead of referring to an 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 S3 location instead of inputting it directly with this parameter.
  - getZipFile
```
public ByteBuffer getZipFile()
```
    If you input your canary script directly into the canary instead of referring to an 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 S3 location instead of inputting it directly with this parameter.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    Returns:
    
    If you input your canary script directly into the canary instead of referring to an 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 S3 location instead of inputting it directly with this parameter.
  - withZipFile
```
public CanaryCodeInput withZipFile(ByteBuffer zipFile)
```
    If you input your canary script directly into the canary instead of referring to an 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 S3 location instead of inputting it directly with this parameter.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    zipFile - If you input your canary script directly into the canary instead of referring to an 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 S3 location instead of inputting it directly with this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHandler
```
public void setHandler(String 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 a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .
    
    Parameters:
    
    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 a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .
  - getHandler
```
public String getHandler()
```
    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 a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/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 a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .
  - withHandler
```
public CanaryCodeInput withHandler(String 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 a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .
    
    Parameters:
    
    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 a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CanaryCodeInput clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CanaryCodeInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanaryCodeInput

Method Detail

setS3Bucket

getS3Bucket

withS3Bucket

setS3Key

getS3Key

withS3Key

setS3Version

getS3Version

withS3Version

setZipFile

getZipFile

withZipFile

setHandler

getHandler

withHandler

toString

equals

hashCode

clone

marshall