org.apache.gravitino.dto.requests

Class CatalogUpdateRequest.UpdateCatalogCommentRequest

java.lang.Object

org.apache.gravitino.dto.requests.CatalogUpdateRequest.UpdateCatalogCommentRequest

All Implemented Interfaces:

CatalogUpdateRequest, RESTMessage, RESTRequest

Enclosing interface:

CatalogUpdateRequest

public static class CatalogUpdateRequest.UpdateCatalogCommentRequest
extends java.lang.Object
implements CatalogUpdateRequest

Request to update the comment of a catalog.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.gravitino.dto.requests.CatalogUpdateRequest

CatalogUpdateRequest.RemoveCatalogPropertyRequest, CatalogUpdateRequest.RenameCatalogRequest, CatalogUpdateRequest.SetCatalogPropertyRequest, CatalogUpdateRequest.UpdateCatalogCommentRequest

Constructor Summary

Constructors

Constructor and Description
UpdateCatalogCommentRequest() Default constructor for UpdateCatalogCommentRequest.
UpdateCatalogCommentRequest(java.lang.String newComment) Constructor for UpdateCatalogCommentRequest.

Method Summary

Modifier and Type	Method and Description
CatalogChange	catalogChange() Returns the catalog change associated with this request.
void	validate() Validates the fields of the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateCatalogCommentRequest

public UpdateCatalogCommentRequest(java.lang.String newComment)

Constructor for UpdateCatalogCommentRequest.

Parameters:

newComment - The new comment for the catalog.

UpdateCatalogCommentRequest

public UpdateCatalogCommentRequest()

Default constructor for UpdateCatalogCommentRequest.

Method Detail

validate

public void validate()
              throws java.lang.IllegalArgumentException

Validates the fields of the request.

Specified by:

validate in interface RESTMessage

Throws:

java.lang.IllegalArgumentException - if the new comment is not set.

catalogChange

public CatalogChange catalogChange()

Description copied from interface: CatalogUpdateRequest

Returns the catalog change associated with this request.

Specified by:

catalogChange in interface CatalogUpdateRequest

Returns:

The catalog change.