Class Function

java.lang.Object
software.amazon.awssdk.services.mediatailor.model.Function
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Function.Builder,Function>
@Generated("software.amazon.awssdk:codegen") public final class Function extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Function.Builder,Function>

-- Define Mixin --

See Also:

  • Method Details

    • functionId

      public final String functionId()

      The identifier of the function.

      Returns:
      The identifier of the function.

    • functionType

      public final FunctionType functionType()

      The type of the function.

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

      Returns:
      The type of the function.
      See Also:

    • functionTypeAsString

      public final String functionTypeAsString()

      The type of the function.

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

      Returns:
      The type of the function.
      See Also:

    • description

      public final String description()

      A description of the function.

      Returns:
      A description of the function.

    • httpRequestConfiguration

      public final HttpRequestConfiguration httpRequestConfiguration()

      The configuration for an HTTP_REQUEST function.

      Returns:
      The configuration for an HTTP_REQUEST function.

    • customOutputConfiguration

      public final CustomOutputConfiguration customOutputConfiguration()

      The configuration for a CUSTOM_OUTPUT function.

      Returns:
      The configuration for a CUSTOM_OUTPUT function.

    • sequentialExecutorConfiguration

      public final SequentialExecutorConfiguration sequentialExecutorConfiguration()

      The configuration for a SEQUENTIAL_EXECUTOR function.

      Returns:
      The configuration for a SEQUENTIAL_EXECUTOR function.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tags assigned to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags assigned to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the function.

      Returns:
      The Amazon Resource Name (ARN) of the function.

    • toBuilder

      public Function.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<Function.Builder,Function>
      Returns:
      a builder for type T

    • builder

      public static Function.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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