Package software.amazon.awssdk.services.synthetics.model

Class DeleteCanaryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.synthetics.model.SyntheticsRequest

software.amazon.awssdk.services.synthetics.model.DeleteCanaryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteCanaryRequest.Builder,DeleteCanaryRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DeleteCanaryRequest
extends SyntheticsRequest
implements ToCopyableBuilder<DeleteCanaryRequest.Builder,DeleteCanaryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteCanaryRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteCanaryRequest.Builder	builder()
Boolean	deleteLambda()	Specifies whether to also delete the Lambda functions and layers used by this canary.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the canary that you want to delete.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteCanaryRequest.Builder>	serializableBuilderClass()
DeleteCanaryRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

Returns:

The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

deleteLambda

public final Boolean deleteLambda()

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

Your setting for this parameter is used only if the canary doesn't have AUTOMATIC for its ProvisionedResourceCleanup field. If that field is set to AUTOMATIC, then the Lambda functions and layers will be deleted when this canary is deleted.

Type: Boolean

Returns:

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

Your setting for this parameter is used only if the canary doesn't have AUTOMATIC for its ProvisionedResourceCleanup field. If that field is set to AUTOMATIC, then the Lambda functions and layers will be deleted when this canary is deleted.

Type: Boolean

toBuilder

public DeleteCanaryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteCanaryRequest.Builder,DeleteCanaryRequest>

Specified by:

toBuilder in class SyntheticsRequest

builder

public static DeleteCanaryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteCanaryRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo