Class GetEntityRecordsRequest

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

  • Method Details

    • connectionName

      public final String connectionName()

      The name of the connection that contains the connection type credentials.

      Returns:
      The name of the connection that contains the connection type credentials.

    • catalogId

      public final String catalogId()

      The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

      Returns:
      The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

    • entityName

      public final String entityName()

      Name of the entity that we want to query the preview data from the given connection type.

      Returns:
      Name of the entity that we want to query the preview data from the given connection type.

    • nextToken

      public final String nextToken()

      A continuation token, included if this is a continuation call.

      Returns:
      A continuation token, included if this is a continuation call.

    • dataStoreApiVersion

      public final String dataStoreApiVersion()

      The API version of the SaaS connector.

      Returns:
      The API version of the SaaS connector.

    • hasConnectionOptions

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

    • connectionOptions

      public final Map<String,String> connectionOptions()

      Connector options that are required to query the data.

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

      Returns:
      Connector options that are required to query the data.

    • filterPredicate

      public final String filterPredicate()

      A filter predicate that you can apply in the query request.

      Returns:
      A filter predicate that you can apply in the query request.

    • limit

      public final Long limit()

      Limits the number of records fetched with the request.

      Returns:
      Limits the number of records fetched with the request.

    • orderBy

      public final String orderBy()

      A parameter that orders the response preview data.

      Returns:
      A parameter that orders the response preview data.

    • hasSelectedFields

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

    • selectedFields

      public final List<String> selectedFields()

      List of fields that we want to fetch as part of preview data.

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

      Returns:
      List of fields that we want to fetch as part of preview data.

    • toBuilder

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

    • builder

      public static GetEntityRecordsRequest.Builder builder()

    • serializableBuilderClass

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