org.apache.gravitino.rest

Interface RESTMessage

All Known Subinterfaces:

CatalogUpdateRequest, FilesetUpdateRequest, MetalakeUpdateRequest, RESTRequest, RESTResponse, SchemaUpdateRequest, TableUpdateRequest, TagUpdateRequest, TopicUpdateRequest

All Known Implementing Classes:

AddPartitionsRequest, BaseResponse, CatalogCreateRequest, CatalogListResponse, CatalogResponse, CatalogUpdateRequest.RemoveCatalogPropertyRequest, CatalogUpdateRequest.RenameCatalogRequest, CatalogUpdateRequest.SetCatalogPropertyRequest, CatalogUpdateRequest.UpdateCatalogCommentRequest, CatalogUpdatesRequest, DeleteResponse, DropResponse, EntityListResponse, ErrorResponse, FilesetCreateRequest, FilesetResponse, FilesetUpdateRequest.RemoveFilesetCommentRequest, FilesetUpdateRequest.RemoveFilesetPropertiesRequest, FilesetUpdateRequest.RenameFilesetRequest, FilesetUpdateRequest.SetFilesetPropertiesRequest, FilesetUpdateRequest.UpdateFilesetCommentRequest, FilesetUpdatesRequest, GroupAddRequest, GroupResponse, MetadataObjectListResponse, MetalakeCreateRequest, MetalakeListResponse, MetalakeResponse, MetalakeUpdateRequest.RemoveMetalakePropertyRequest, MetalakeUpdateRequest.RenameMetalakeRequest, MetalakeUpdateRequest.SetMetalakePropertyRequest, MetalakeUpdateRequest.UpdateMetalakeCommentRequest, MetalakeUpdatesRequest, NameListResponse, OAuth2ErrorResponse, OAuth2TokenResponse, OwnerResponse, OwnerSetRequest, PartitionListResponse, PartitionNameListResponse, PartitionResponse, RemoveResponse, RoleCreateRequest, RoleGrantRequest, RoleResponse, RoleRevokeRequest, SchemaCreateRequest, SchemaResponse, SchemaUpdateRequest.RemoveSchemaPropertyRequest, SchemaUpdateRequest.SetSchemaPropertyRequest, SchemaUpdatesRequest, SetResponse, TableCreateRequest, TableResponse, 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, TableUpdatesRequest, TagCreateRequest, TagListResponse, TagResponse, TagsAssociateRequest, TagUpdateRequest.RemoveTagPropertyRequest, TagUpdateRequest.RenameTagRequest, TagUpdateRequest.SetTagPropertyRequest, TagUpdateRequest.UpdateTagCommentRequest, TagUpdatesRequest, TopicCreateRequest, TopicResponse, TopicUpdateRequest.RemoveTopicPropertyRequest, TopicUpdateRequest.SetTopicPropertyRequest, TopicUpdateRequest.UpdateTopicCommentRequest, TopicUpdatesRequest, UserAddRequest, UserResponse, VersionResponse

public interface RESTMessage

Interface for REST messages.

REST messages are objects that are sent to and received from REST endpoints. They are typically used to represent the request and response bodies of REST API calls.

Method Summary

Modifier and Type	Method and Description
void	validate() Ensures that a constructed instance of a REST message is valid according to the REST spec.

Method Detail

validate

void validate()
       throws java.lang.IllegalArgumentException

Ensures that a constructed instance of a REST message is valid according to the REST spec.

This is needed when parsing data that comes from external sources and the object might have been constructed without all the required fields present.

Throws:

java.lang.IllegalArgumentException