Package org.opensearch.client

Interface Validatable

All Known Implementing Classes:
AnalyzeRequest, CancelTasksRequest, CloseIndexRequest, ComponentTemplatesExistRequest, ComposableIndexTemplateExistRequest, CreateDataStreamRequest, CreateIndexRequest, DataStreamsStatsRequest, DeleteAliasRequest, DeleteComponentTemplateRequest, DeleteComposableIndexTemplateRequest, DeleteDataStreamRequest, DeleteSnapshotLifecyclePolicyRequest, ExecuteSnapshotLifecyclePolicyRequest, ExecuteSnapshotLifecycleRetentionRequest, GetComponentTemplatesRequest, GetComposableIndexTemplateRequest, GetDataStreamRequest, GetFieldMappingsRequest, GetIndexRequest, GetIndexTemplatesRequest, GetMappingsRequest, GetSnapshotLifecyclePolicyRequest, GetSnapshotLifecycleStatsRequest, GetSourceRequest, GetTaskRequest, IndexTemplatesExistRequest, MainRequest, MultiTermVectorsRequest, PutComponentTemplateRequest, PutComposableIndexTemplateRequest, PutMappingRequest, PutSnapshotLifecyclePolicyRequest, RemoteInfoRequest, ResizeRequest, RethrottleRequest, RolloverRequest, SimulateIndexTemplateRequest, SnapshotLifecycleManagementStatusRequest, StartSLMRequest, StopSLMRequest, TermVectorsRequest, TimedRequest
public interface Validatable
Defines a validation layer for Requests.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Validatable EMPTY  

  • Method Summary

    Modifier and Type Method Description
    default java.util.Optional<ValidationException> validate()
    Perform validation.

  • Field Details

  • Method Details

    • validate

      default java.util.Optional<ValidationException> validate()
      Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Returns:
      An Optional ValidationException that contains a list of validation errors.