Class SourceConfiguration

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

Configuration that defines how to make requests to endpoints, including request methods, paths, parameters, and response handling.

See Also:

  • Method Details

    • requestMethod

      public final HTTPMethod requestMethod()

      The HTTP method to use for requests to this endpoint, such as GET, POST.

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

      Returns:
      The HTTP method to use for requests to this endpoint, such as GET, POST.
      See Also:

    • requestMethodAsString

      public final String requestMethodAsString()

      The HTTP method to use for requests to this endpoint, such as GET, POST.

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

      Returns:
      The HTTP method to use for requests to this endpoint, such as GET, POST.
      See Also:

    • requestPath

      public final String requestPath()

      The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

      Returns:
      The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

    • hasRequestParameters

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

    • requestParameters

      public final List<ConnectorProperty> requestParameters()

      Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

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

      Returns:
      Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

    • responseConfiguration

      public final ResponseConfiguration responseConfiguration()

      Configuration that defines how to parse and extract data from API responses, including success and error handling.

      Returns:
      Configuration that defines how to parse and extract data from API responses, including success and error handling.

    • paginationConfiguration

      public final PaginationConfiguration paginationConfiguration()

      Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

      Returns:
      Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

    • toBuilder

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

    • builder

      public static SourceConfiguration.Builder builder()

    • serializableBuilderClass

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