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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSourceConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SourceConfiguration.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRequestParameters()For responses, this returns true if the service returned a value for the RequestParameters property.PaginationConfigurationpaginationConfiguration()Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.HTTPMethodrequestMethod()The HTTP method to use for requests to this endpoint, such as GET, POST.StringrequestMethodAsString()The HTTP method to use for requests to this endpoint, such as GET, POST.List<ConnectorProperty>requestParameters()Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.StringrequestPath()The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.ResponseConfigurationresponseConfiguration()Configuration that defines how to parse and extract data from API responses, including success and error handling.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends SourceConfiguration.Builder>serializableBuilderClass()SourceConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
requestMethodwill returnHTTPMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrequestMethodAsString().- Returns:
- The HTTP method to use for requests to this endpoint, such as GET, POST.
- See Also:
HTTPMethod
-
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,
requestMethodwill returnHTTPMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrequestMethodAsString().- Returns:
- The HTTP method to use for requests to this endpoint, such as GET, POST.
- See Also:
HTTPMethod
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SourceConfiguration.Builder,SourceConfiguration>
-
builder
public static SourceConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends SourceConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-