Class UserDefinedFunction

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

Represents the equivalent of a Hive user-defined function (UDF) definition.

See Also:

  • Method Details

    • functionName

      public final String functionName()

      The name of the function.

      Returns:
      The name of the function.

    • databaseName

      public final String databaseName()

      The name of the catalog database that contains the function.

      Returns:
      The name of the catalog database that contains the function.

    • className

      public final String className()

      The Java class that contains the function code.

      Returns:
      The Java class that contains the function code.

    • ownerName

      public final String ownerName()

      The owner of the function.

      Returns:
      The owner of the function.

    • ownerType

      public final PrincipalType ownerType()

      The owner type.

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

      Returns:
      The owner type.
      See Also:

    • ownerTypeAsString

      public final String ownerTypeAsString()

      The owner type.

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

      Returns:
      The owner type.
      See Also:

    • createTime

      public final Instant createTime()

      The time at which the function was created.

      Returns:
      The time at which the function was created.

    • hasResourceUris

      public final boolean hasResourceUris()
      For responses, this returns true if the service returned a value for the ResourceUris 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.

    • resourceUris

      public final List<ResourceUri> resourceUris()

      The resource URIs for the function.

      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 hasResourceUris() method.

      Returns:
      The resource URIs for the function.

    • catalogId

      public final String catalogId()

      The ID of the Data Catalog in which the function resides.

      Returns:
      The ID of the Data Catalog in which the function resides.

    • toBuilder

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

    • builder

      public static UserDefinedFunction.Builder builder()

    • serializableBuilderClass

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