Interface CanaryCodeInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>, SdkBuilder<CanaryCodeInput.Builder,CanaryCodeInput>, SdkPojo
Enclosing class:
CanaryCodeInput
@Mutable @NotThreadSafe public static interface CanaryCodeInput.Builder extends SdkPojo, CopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>

  • Method Details

    • s3Bucket

      CanaryCodeInput.Builder s3Bucket(String 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • s3Key

      CanaryCodeInput.Builder s3Key(String s3Key)

      The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects.

      Parameters:
      s3Key - The Amazon 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.

    • s3Version

      CanaryCodeInput.Builder s3Version(String s3Version)

      The Amazon S3 version ID of your script.

      Parameters:
      s3Version - The Amazon S3 version ID of your script.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • zipFile

      CanaryCodeInput.Builder zipFile(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. 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • handler

      CanaryCodeInput.Builder handler(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.

    • dependencies

      CanaryCodeInput.Builder dependencies(Collection<Dependency> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependencies

      CanaryCodeInput.Builder dependencies(Dependency... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependencies

      CanaryCodeInput.Builder dependencies(Consumer<Dependency.Builder>... 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.

      This is a convenience method that creates an instance of the Dependency.Builder avoiding the need to create one manually via Dependency.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dependencies(List<Dependency>).

      Parameters:
      dependencies - a consumer that will call methods on Dependency.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: