Package org.apache.gravitino.dto.requests

Class TableUpdateRequest.UpdateTableColumnCommentRequest

java.lang.Object

org.apache.gravitino.dto.requests.TableUpdateRequest.UpdateTableColumnCommentRequest

All Implemented Interfaces:

TableUpdateRequest, RESTMessage, RESTRequest

Enclosing interface:

TableUpdateRequest

public static class TableUpdateRequest.UpdateTableColumnCommentRequest
extends Object
implements TableUpdateRequest

Represents a request to update the comment of a column of 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	Description
UpdateTableColumnCommentRequest()	Default constructor for Jackson deserialization.
UpdateTableColumnCommentRequest(String[] fieldName, String newComment)	Constructor for UpdateTableColumnCommentRequest.

Method Summary

Modifier and Type	Method	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 Details

UpdateTableColumnCommentRequest

public UpdateTableColumnCommentRequest(String[] fieldName,
 String newComment)

Constructor for UpdateTableColumnCommentRequest.

Parameters:

fieldName - the field name to update

newComment - the new comment of the field

UpdateTableColumnCommentRequest

public UpdateTableColumnCommentRequest()

Default constructor for Jackson deserialization.

Method Details

validate

public void validate()
              throws IllegalArgumentException

Validates the request.

Specified by:

validate in interface RESTMessage

Throws:

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.