Class InvokeRestApiRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mwaa.model.MwaaRequest
software.amazon.awssdk.services.mwaa.model.InvokeRestApiRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeRestApiRequest.Builder,InvokeRestApiRequest>
@Generated("software.amazon.awssdk:codegen") public final class InvokeRestApiRequest extends MwaaRequest implements ToCopyableBuilder<InvokeRestApiRequest.Builder,InvokeRestApiRequest>

  • Method Details

    • name

      public final String name()

      The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

      Returns:
      The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

    • path

      public final String path()

      The Apache Airflow REST API endpoint path to be called. For example, /dags/123456/clearTaskInstances . For more information, see Apache Airflow API

      Returns:
      The Apache Airflow REST API endpoint path to be called. For example, /dags/123456/clearTaskInstances. For more information, see Apache Airflow API

    • method

      public final RestApiMethod method()

      The HTTP method used for making Airflow REST API calls. For example, POST.

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

      Returns:
      The HTTP method used for making Airflow REST API calls. For example, POST.
      See Also:

    • methodAsString

      public final String methodAsString()

      The HTTP method used for making Airflow REST API calls. For example, POST.

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

      Returns:
      The HTTP method used for making Airflow REST API calls. For example, POST.
      See Also:

    • queryParameters

      public final Document queryParameters()

      Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object.

      Returns:
      Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object.

    • body

      public final Document body()

      The request body for the Apache Airflow REST API call, provided as a JSON object.

      Returns:
      The request body for the Apache Airflow REST API call, provided as a JSON object.

    • toBuilder

      public InvokeRestApiRequest.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<InvokeRestApiRequest.Builder,InvokeRestApiRequest>
      Specified by:
      toBuilder in class MwaaRequest
      Returns:
      a builder for type T

    • builder

      public static InvokeRestApiRequest.Builder builder()

    • serializableBuilderClass

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