Class GetTablesRequest

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

  • Method Details

    • catalogId

      public final String catalogId()

      The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

      Returns:
      The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

    • databaseName

      public final String databaseName()

      The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

      Returns:
      The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

    • expression

      public final String expression()

      A regular expression pattern. If present, only those tables whose names match the pattern are returned.

      Returns:
      A regular expression pattern. If present, only those tables whose names match the pattern are returned.

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

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

    • transactionId

      public final String transactionId()

      The transaction ID at which to read the table contents.

      Returns:
      The transaction ID at which to read the table contents.

    • queryAsOfTime

      public final Instant queryAsOfTime()

      The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

      Returns:
      The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

    • includeStatusDetails

      public final Boolean includeStatusDetails()

      Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.

      Returns:
      Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.

    • attributesToGet

      public final List<TableAttributes> attributesToGet()

      Specifies the table fields returned by the GetTables call. This parameter doesn’t accept an empty list. The request must include NAME.

      The following are the valid combinations of values:

      • NAME - Names of all tables in the database.

      • NAME, TABLE_TYPE - Names of all tables and the table types.

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

      Returns:
      Specifies the table fields returned by the GetTables call. This parameter doesn’t accept an empty list. The request must include NAME.

      The following are the valid combinations of values:

      • NAME - Names of all tables in the database.

      • NAME, TABLE_TYPE - Names of all tables and the table types.

    • hasAttributesToGet

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

    • attributesToGetAsStrings

      public final List<String> attributesToGetAsStrings()

      Specifies the table fields returned by the GetTables call. This parameter doesn’t accept an empty list. The request must include NAME.

      The following are the valid combinations of values:

      • NAME - Names of all tables in the database.

      • NAME, TABLE_TYPE - Names of all tables and the table types.

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

      Returns:
      Specifies the table fields returned by the GetTables call. This parameter doesn’t accept an empty list. The request must include NAME.

      The following are the valid combinations of values:

      • NAME - Names of all tables in the database.

      • NAME, TABLE_TYPE - Names of all tables and the table types.

    • toBuilder

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

    • builder

      public static GetTablesRequest.Builder builder()

    • serializableBuilderClass

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