Package software.amazon.awssdk.services.sfn.model

Class DescribeStateMachineForExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sfn.model.SfnRequest

software.amazon.awssdk.services.sfn.model.DescribeStateMachineForExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStateMachineForExecutionRequest.Builder,DescribeStateMachineForExecutionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStateMachineForExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeStateMachineForExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionArn()	The Amazon Resource Name (ARN) of the execution you want state machine information for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IncludedData	includedData()	If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
String	includedDataAsString()	If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStateMachineForExecutionRequest.Builder>	serializableBuilderClass()
DescribeStateMachineForExecutionRequest.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

executionArn

public final String executionArn()

The Amazon Resource Name (ARN) of the execution you want state machine information for.

Returns:

The Amazon Resource Name (ARN) of the execution you want state machine information for.

includedData

public final IncludedData includedData()

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

If the service returns an enum value that is not available in the current SDK version, includedData will return IncludedData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includedDataAsString().

Returns:

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

See Also:

IncludedData

includedDataAsString

public final String includedDataAsString()

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

If the service returns an enum value that is not available in the current SDK version, includedData will return IncludedData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includedDataAsString().

Returns:

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

See Also:

IncludedData

toBuilder

public DescribeStateMachineForExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStateMachineForExecutionRequest.Builder,DescribeStateMachineForExecutionRequest>

Specified by:

toBuilder in class SfnRequest

builder

public static DescribeStateMachineForExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeStateMachineForExecutionRequest.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