org.apache.gravitino.dto.requests

Class TableUpdateRequest.DeleteTableColumnRequest

java.lang.Object

org.apache.gravitino.dto.requests.TableUpdateRequest.DeleteTableColumnRequest

All Implemented Interfaces:

TableUpdateRequest, RESTMessage, RESTRequest

Enclosing interface:

TableUpdateRequest

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

Represents a request to delete a column from a table.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.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
DeleteTableColumnRequest() Default constructor for Jackson deserialization.
DeleteTableColumnRequest(java.lang.String[] fieldName, boolean ifExists) Constructor for DeleteTableColumnRequest.

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

DeleteTableColumnRequest

public DeleteTableColumnRequest(java.lang.String[] fieldName,
                                boolean ifExists)

Constructor for DeleteTableColumnRequest.

Parameters:

fieldName - the field name to delete

ifExists - whether to delete the column if it exists

DeleteTableColumnRequest

public DeleteTableColumnRequest()

Default constructor for Jackson deserialization.

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.