com.basho.riak.client.api.commands.timeseries.DescribeTable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riak-client Show documentation

HttpClient-based client for Riak

The newest version!

package com.basho.riak.client.api.commands.timeseries;

import com.basho.riak.client.api.AsIsRiakCommand;
import com.basho.riak.client.core.operations.ts.DescribeTableOperation;
import com.basho.riak.client.core.query.timeseries.TableDefinition;

/**
 * Time Series DescribeTable Command
 * Allows you to fetch a table definition from Riak Time Series.
 *
 * @author Alex Moore 
  * @since 2.0.4
 */
public class DescribeTable extends AsIsRiakCommand
{
    private final String tableName;

    /**
     * Create a new DescribeTable command.
     * No Builder is required.
     *
     * @param tableName The name of the table to fetch a definition for. Required, must not be empty or null.
     */
    public DescribeTable(String tableName)
    {
        if (tableName == null || tableName.isEmpty())
        {
            throw new IllegalArgumentException("Table Name must not be null or empty.");
        }

        this.tableName = tableName;
    }

    @Override
    protected DescribeTableOperation buildCoreOperation()
    {
        return new DescribeTableOperation(this.tableName);
    }
}