Class TestFunctionRequest

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

  • Method Details

    • name

      public final String name()

      The name of the function that you are testing.

      Returns:
      The name of the function that you are testing.

    • ifMatch

      public final String ifMatch()

      The current version (ETag value) of the function that you are testing, which you can get using DescribeFunction.

      Returns:
      The current version (ETag value) of the function that you are testing, which you can get using DescribeFunction.

    • stage

      public final FunctionStage stage()

      The stage of the function that you are testing, either DEVELOPMENT or LIVE.

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

      Returns:
      The stage of the function that you are testing, either DEVELOPMENT or LIVE.
      See Also:

    • stageAsString

      public final String stageAsString()

      The stage of the function that you are testing, either DEVELOPMENT or LIVE.

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

      Returns:
      The stage of the function that you are testing, either DEVELOPMENT or LIVE.
      See Also:

    • eventObject

      public final SdkBytes eventObject()

      The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.

      Returns:
      The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.

    • toBuilder

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

    • builder

      public static TestFunctionRequest.Builder builder()

    • serializableBuilderClass

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