Class GetTableObjectsRequest

    • Method Detail

      • catalogId

        public final String catalogId()

        The catalog containing the governed table. Defaults to the caller’s account.

        Returns:
        The catalog containing the governed table. Defaults to the caller’s account.
      • databaseName

        public final String databaseName()

        The database containing the governed table.

        Returns:
        The database containing the governed table.
      • tableName

        public final String tableName()

        The governed table for which to retrieve objects.

        Returns:
        The governed table for which to retrieve objects.
      • transactionId

        public final String transactionId()

        The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.

        Returns:
        The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.
      • queryAsOfTime

        public final Instant queryAsOfTime()

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

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

        public final String partitionPredicate()

        A predicate to filter the objects returned based on the partition keys defined in the governed table.

        • The comparison operators supported are: =, >, <, >=, <=

        • The logical operators supported are: AND

        • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.

        Returns:
        A predicate to filter the objects returned based on the partition keys defined in the governed table.

        • The comparison operators supported are: =, >, <, >=, <=

        • The logical operators supported are: AND

        • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.

      • maxResults

        public final Integer maxResults()

        Specifies how many values to return in a page.

        Returns:
        Specifies how many values to return in a page.
      • nextToken

        public final String nextToken()

        A continuation token if this is not the first call to retrieve these objects.

        Returns:
        A continuation token if this is not the first call to retrieve these objects.
      • 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