Package org.opensearch.client.opensearch._global

Class DeleteRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch._global.DeleteRequest
public final class DeleteRequest
extends RequestBase

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  DeleteRequest.Builder
    Builder for DeleteRequest.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Endpoint<DeleteRequest,​DeleteResponse,​OpenSearchError> ENDPOINT
    Endpoint "delete".

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected DeleteRequest​(DeleteRequest.Builder builder)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String id()
    API name: id
    java.lang.Number ifPrimaryTerm()
    API name: if_primary_term
    java.lang.Number ifSeqNo()
    API name: if_seq_no
    java.lang.String index()
    API name: index
    jakarta.json.JsonValue refresh()
    API name: refresh
    jakarta.json.JsonValue routing()
    API name: routing
    jakarta.json.JsonValue timeout()
    API name: timeout
    java.lang.String type()
    API name: type
    java.lang.Number version()
    API name: version
    jakarta.json.JsonValue versionType()
    API name: version_type
    jakarta.json.JsonValue waitForActiveShards()
    API name: wait_for_active_shards

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • id

      public java.lang.String id()
      API name: id

    • index

      public java.lang.String index()
      API name: index

    • type

      @Nullable public java.lang.String type()
      API name: type

    • ifPrimaryTerm

      @Nullable public java.lang.Number ifPrimaryTerm()
      API name: if_primary_term

    • ifSeqNo

      @Nullable public java.lang.Number ifSeqNo()
      API name: if_seq_no

    • refresh

      @Nullable public jakarta.json.JsonValue refresh()
      API name: refresh

    • routing

      @Nullable public jakarta.json.JsonValue routing()
      API name: routing

    • timeout

      @Nullable public jakarta.json.JsonValue timeout()
      API name: timeout

    • version

      @Nullable public java.lang.Number version()
      API name: version

    • versionType

      @Nullable public jakarta.json.JsonValue versionType()
      API name: version_type

    • waitForActiveShards

      @Nullable public jakarta.json.JsonValue waitForActiveShards()
      API name: wait_for_active_shards