com.datastrato.gravitino.dto.requests

Class TableUpdateRequest.AddTableIndexRequest

java.lang.Object

com.datastrato.gravitino.dto.requests.TableUpdateRequest.AddTableIndexRequest

All Implemented Interfaces:

TableUpdateRequest, RESTMessage, RESTRequest

Enclosing interface:

TableUpdateRequest

public static class TableUpdateRequest.AddTableIndexRequest
extends java.lang.Object
implements TableUpdateRequest

Represents a request to add an index to a table.

Nested Class Summary

Nested classes/interfaces inherited from interface com.datastrato.gravitino.dto.requests.TableUpdateRequest

TableUpdateRequest.AddTableColumnRequest, TableUpdateRequest.AddTableIndexRequest, TableUpdateRequest.DeleteTableColumnRequest, TableUpdateRequest.DeleteTableIndexRequest, TableUpdateRequest.RemoveTablePropertyRequest, TableUpdateRequest.RenameTableColumnRequest, TableUpdateRequest.RenameTableRequest, TableUpdateRequest.SetTablePropertyRequest, TableUpdateRequest.UpdateColumnAutoIncrementRequest, TableUpdateRequest.UpdateTableColumnCommentRequest, TableUpdateRequest.UpdateTableColumnDefaultValueRequest, TableUpdateRequest.UpdateTableColumnNullabilityRequest, TableUpdateRequest.UpdateTableColumnPositionRequest, TableUpdateRequest.UpdateTableColumnTypeRequest, TableUpdateRequest.UpdateTableCommentRequest

Constructor Summary

Constructors

Constructor and Description
AddTableIndexRequest() Default constructor for Jackson deserialization.
AddTableIndexRequest(Index.IndexType type, java.lang.String name, java.lang.String[][] fieldNames) The constructor of the add table index request.

Method Summary

Modifier and Type	Method and Description
TableChange	tableChange() The table change that is requested.
void	validate() Validates the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddTableIndexRequest

public AddTableIndexRequest()

Default constructor for Jackson deserialization.

AddTableIndexRequest

public AddTableIndexRequest(Index.IndexType type,
                            java.lang.String name,
                            java.lang.String[][] fieldNames)

The constructor of the add table index request.

Parameters:

type - The type of the index

name - The name of the index

fieldNames - The field names under the table contained in the index.

Method Detail

validate

public void validate()
              throws java.lang.IllegalArgumentException

Validates the request.

Specified by:

validate in interface RESTMessage

Throws:

java.lang.IllegalArgumentException - If the request is invalid, this exception is thrown.

tableChange

public TableChange tableChange()

Description copied from interface: TableUpdateRequest

The table change that is requested.

Specified by:

tableChange in interface TableUpdateRequest

Returns:

An instance of TableChange.