Class StartSyncExecutionRequest

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.StartSyncExecutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartSyncExecutionRequest.Builder,StartSyncExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartSyncExecutionRequest extends SfnRequest implements ToCopyableBuilder<StartSyncExecutionRequest.Builder,StartSyncExecutionRequest>

  • Method Details

    • stateMachineArn

      public final String stateMachineArn()

      The Amazon Resource Name (ARN) of the state machine to execute.

      Returns:
      The Amazon Resource Name (ARN) of the state machine to execute.

    • name

      public final String name()

      The name of the execution.

      Returns:
      The name of the execution.

    • input

      public final String input()

      The string that contains the JSON input data for the execution, for example:

      "input": "{\"first_name\" : \"test\"}"

      If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

      Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

      Returns:
      The string that contains the JSON input data for the execution, for example:

      "input": "{\"first_name\" : \"test\"}"

      If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

      Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    • traceHeader

      public final String traceHeader()

      Passes the X-Ray trace header. The trace header can also be passed in the request payload.

      Returns:
      Passes the X-Ray trace header. The trace header can also be passed in the request payload.

    • 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:

    • 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:

    • toBuilder

      public StartSyncExecutionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartSyncExecutionRequest.Builder,StartSyncExecutionRequest>
      Specified by:
      toBuilder in class SfnRequest
      Returns:
      a builder for type T

    • builder

      public static StartSyncExecutionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartSyncExecutionRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.