CanaryRunConfigInput (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.synthetics.model.CanaryRunConfigInput

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class CanaryRunConfigInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>

A structure that contains input information for a canary run.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CanaryRunConfigInput.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CanaryRunConfigInput.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`activeTracing()` Specifies whether this canary is to use active X-Ray tracing when it runs.
`static CanaryRunConfigInput.Builder`	`builder()`
`Map<String,String>`	`environmentVariables()` Specifies the keys and values to use for any environment variables used in the canary script.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEnvironmentVariables()` For responses, this returns true if the service returned a value for the EnvironmentVariables property.
`int`	`hashCode()`
`Integer`	`memoryInMB()` The maximum amount of memory available to the canary while it is running, in MB.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CanaryRunConfigInput.Builder>`	`serializableBuilderClass()`
`Integer`	`timeoutInSeconds()` How long the canary is allowed to run before it must stop.
`CanaryRunConfigInput.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - timeoutInSeconds
```
public final Integer timeoutInSeconds()
```
    How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.
    
    If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
    
    Returns:
    
    How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.
    
    If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
  - memoryInMB
```
public final Integer memoryInMB()
```
    The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
    
    Returns:
    
    The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
  - activeTracing
```
public final Boolean activeTracing()
```
    Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.
    
    You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
    
    Returns:
    
    Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.
    
    You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
  - hasEnvironmentVariables
```
public final boolean hasEnvironmentVariables()
```
    For responses, this returns true if the service returned a value for the EnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - environmentVariables
```
public final Map<String,String> environmentVariables()
```
    Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:
    
    { "key1" : "value1", "key2" : "value2", ...}
    
    Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
    
    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 hasEnvironmentVariables() method.
    
    Returns:
    
    Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:
    
    { "key1" : "value1", "key2" : "value2", ...}
    
    Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
  - toBuilder
```
public CanaryRunConfigInput.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>
  - builder
```
public static CanaryRunConfigInput.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CanaryRunConfigInput.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CanaryRunConfigInput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

timeoutInSeconds

memoryInMB

activeTracing

hasEnvironmentVariables

environmentVariables

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields