Package software.amazon.awssdk.services.glue.model

Class SearchTablesRequest

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.SearchTablesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchTablesRequest.Builder,SearchTablesRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchTablesRequest extends GlueRequest implements ToCopyableBuilder<SearchTablesRequest.Builder,SearchTablesRequest>

  • Method Details

    • catalogId

      public final String catalogId()

      A unique identifier, consisting of account_id .

      Returns:
      A unique identifier, consisting of account_id .

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

    • hasFilters

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

    • filters

      public final List<PropertyPredicate> filters()

      A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

      The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

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

      Returns:
      A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

      The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

    • searchText

      public final String searchText()

      A string used for a text search.

      Specifying a value in quotes filters based on an exact match to the value.

      Returns:
      A string used for a text search.

      Specifying a value in quotes filters based on an exact match to the value.

    • hasSortCriteria

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

    • sortCriteria

      public final List<SortCriterion> sortCriteria()

      A list of criteria for sorting the results by a field name, in an ascending or descending order.

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

      Returns:
      A list of criteria for sorting the results by a field name, in an ascending or descending order.

    • maxResults

      public final Integer maxResults()

      The maximum number of tables to return in a single response.

      Returns:
      The maximum number of tables to return in a single response.

    • resourceShareType

      public final ResourceShareType resourceShareType()

      Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

      • If set to FOREIGN, will search the tables shared with your account.

      • If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

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

      Returns:
      Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

      • If set to FOREIGN, will search the tables shared with your account.

      • If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

      See Also:

    • resourceShareTypeAsString

      public final String resourceShareTypeAsString()

      Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

      • If set to FOREIGN, will search the tables shared with your account.

      • If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

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

      Returns:
      Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

      • If set to FOREIGN, will search the tables shared with your account.

      • If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

      See Also:

    • toBuilder

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

    • builder

      public static SearchTablesRequest.Builder builder()

    • serializableBuilderClass

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