org.apache.gravitino.dto.requests

Class TableUpdateRequest.UpdateTableCommentRequest

java.lang.Object

org.apache.gravitino.dto.requests.TableUpdateRequest.UpdateTableCommentRequest

All Implemented Interfaces:

TableUpdateRequest, RESTMessage, RESTRequest

Enclosing interface:

TableUpdateRequest

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

Represents a request to update the comment 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 and Description
UpdateTableCommentRequest() Default constructor for Jackson deserialization.
UpdateTableCommentRequest(java.lang.String newComment) Constructor for UpdateTableCommentRequest.

Method Summary

Modifier and Type	Method and Description
TableChange	tableChange() Returns the table change.
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

UpdateTableCommentRequest

public UpdateTableCommentRequest(java.lang.String newComment)

Constructor for UpdateTableCommentRequest.

Parameters:

newComment - the new comment of the table

UpdateTableCommentRequest

public UpdateTableCommentRequest()

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()

Returns the table change.

Specified by:

tableChange in interface TableUpdateRequest

Returns:

An instance of TableChange.