Package org.opensearch.protobufs

Interface GetDocumentRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GetDocumentRequest, GetDocumentRequest.Builder
public interface GetDocumentRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    string id = 1 [json_name = "id"];
    com.google.protobuf.ByteString
    getIdBytes()
    string id = 1 [json_name = "id"];
    String
    getIndex()
    string index = 2 [json_name = "index"];
    com.google.protobuf.ByteString
    getIndexBytes()
    string index = 2 [json_name = "index"];
    String
    getPreference()
    optional string preference = 6 [json_name = "preference"];
    com.google.protobuf.ByteString
    getPreferenceBytes()
    optional string preference = 6 [json_name = "preference"];
    boolean
    getRealtime()
    optional bool realtime = 7 [json_name = "realtime"];
    boolean
    getRefresh()
    optional bool refresh = 8 [json_name = "refresh"];
    String
    getRouting()
    optional string routing = 9 [json_name = "routing"];
    com.google.protobuf.ByteString
    getRoutingBytes()
    optional string routing = 9 [json_name = "routing"];
    SourceType
    getSourceType()
    optional .SourceType source_type = 13 [json_name = "sourceType"];
    int
    getSourceTypeValue()
    optional .SourceType source_type = 13 [json_name = "sourceType"];
    String
    getStoredFields(int index)
    repeated string stored_fields = 10 [json_name = "storedFields"];
    com.google.protobuf.ByteString
    getStoredFieldsBytes(int index)
    repeated string stored_fields = 10 [json_name = "storedFields"];
    int
    getStoredFieldsCount()
    repeated string stored_fields = 10 [json_name = "storedFields"];
    List<String>
    getStoredFieldsList()
    repeated string stored_fields = 10 [json_name = "storedFields"];
    long
    getVersion()
    optional int64 version = 11 [json_name = "version"];
    VersionType
    getVersionType()
    optional .VersionType version_type = 12 [json_name = "versionType"];
    int
    getVersionTypeValue()
    optional .VersionType version_type = 12 [json_name = "versionType"];
    SourceConfigParam
    getXSource()
    optional .SourceConfigParam x_source = 3 [json_name = "xSource"];
    String
    getXSourceExcludes(int index)
    repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
    com.google.protobuf.ByteString
    getXSourceExcludesBytes(int index)
    repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
    int
    getXSourceExcludesCount()
    repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
    List<String>
    getXSourceExcludesList()
    repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
    String
    getXSourceIncludes(int index)
    repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
    com.google.protobuf.ByteString
    getXSourceIncludesBytes(int index)
    repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
    int
    getXSourceIncludesCount()
    repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
    List<String>
    getXSourceIncludesList()
    repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
    SourceConfigParamOrBuilder
    getXSourceOrBuilder()
    optional .SourceConfigParam x_source = 3 [json_name = "xSource"];
    boolean
    hasPreference()
    optional string preference = 6 [json_name = "preference"];
    boolean
    hasRealtime()
    optional bool realtime = 7 [json_name = "realtime"];
    boolean
    hasRefresh()
    optional bool refresh = 8 [json_name = "refresh"];
    boolean
    hasRouting()
    optional string routing = 9 [json_name = "routing"];
    boolean
    hasSourceType()
    optional .SourceType source_type = 13 [json_name = "sourceType"];
    boolean
    hasVersion()
    optional int64 version = 11 [json_name = "version"];
    boolean
    hasVersionType()
    optional .VersionType version_type = 12 [json_name = "versionType"];
    boolean
    hasXSource()
    optional .SourceConfigParam x_source = 3 [json_name = "xSource"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
      string id = 1 [json_name = "id"];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      string id = 1 [json_name = "id"];
      Returns:
      The bytes for id.

    • getIndex

      String getIndex()
      string index = 2 [json_name = "index"];
      Returns:
      The index.

    • getIndexBytes

      com.google.protobuf.ByteString getIndexBytes()
      string index = 2 [json_name = "index"];
      Returns:
      The bytes for index.

    • hasXSource

      boolean hasXSource()
      optional .SourceConfigParam x_source = 3 [json_name = "xSource"];
      Returns:
      Whether the xSource field is set.

    • getXSource

      SourceConfigParam getXSource()
      optional .SourceConfigParam x_source = 3 [json_name = "xSource"];
      Returns:
      The xSource.

    • getXSourceOrBuilder

      SourceConfigParamOrBuilder getXSourceOrBuilder()
      optional .SourceConfigParam x_source = 3 [json_name = "xSource"];

    • getXSourceExcludesList

      List<String> getXSourceExcludesList()
      repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
      Returns:
      A list containing the xSourceExcludes.

    • getXSourceExcludesCount

      int getXSourceExcludesCount()
      repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
      Returns:
      The count of xSourceExcludes.

    • getXSourceExcludes

      String getXSourceExcludes(int index)
      repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The xSourceExcludes at the given index.

    • getXSourceExcludesBytes

      com.google.protobuf.ByteString getXSourceExcludesBytes(int index)
      repeated string x_source_excludes = 4 [json_name = "xSourceExcludes"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the xSourceExcludes at the given index.

    • getXSourceIncludesList

      List<String> getXSourceIncludesList()
      repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
      Returns:
      A list containing the xSourceIncludes.

    • getXSourceIncludesCount

      int getXSourceIncludesCount()
      repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
      Returns:
      The count of xSourceIncludes.

    • getXSourceIncludes

      String getXSourceIncludes(int index)
      repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The xSourceIncludes at the given index.

    • getXSourceIncludesBytes

      com.google.protobuf.ByteString getXSourceIncludesBytes(int index)
      repeated string x_source_includes = 5 [json_name = "xSourceIncludes"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the xSourceIncludes at the given index.

    • hasPreference

      boolean hasPreference()
      optional string preference = 6 [json_name = "preference"];
      Returns:
      Whether the preference field is set.

    • getPreference

      String getPreference()
      optional string preference = 6 [json_name = "preference"];
      Returns:
      The preference.

    • getPreferenceBytes

      com.google.protobuf.ByteString getPreferenceBytes()
      optional string preference = 6 [json_name = "preference"];
      Returns:
      The bytes for preference.

    • hasRealtime

      boolean hasRealtime()
      optional bool realtime = 7 [json_name = "realtime"];
      Returns:
      Whether the realtime field is set.

    • getRealtime

      boolean getRealtime()
      optional bool realtime = 7 [json_name = "realtime"];
      Returns:
      The realtime.

    • hasRefresh

      boolean hasRefresh()
      optional bool refresh = 8 [json_name = "refresh"];
      Returns:
      Whether the refresh field is set.

    • getRefresh

      boolean getRefresh()
      optional bool refresh = 8 [json_name = "refresh"];
      Returns:
      The refresh.

    • hasRouting

      boolean hasRouting()
      optional string routing = 9 [json_name = "routing"];
      Returns:
      Whether the routing field is set.

    • getRouting

      String getRouting()
      optional string routing = 9 [json_name = "routing"];
      Returns:
      The routing.

    • getRoutingBytes

      com.google.protobuf.ByteString getRoutingBytes()
      optional string routing = 9 [json_name = "routing"];
      Returns:
      The bytes for routing.

    • getStoredFieldsList

      List<String> getStoredFieldsList()
      repeated string stored_fields = 10 [json_name = "storedFields"];
      Returns:
      A list containing the storedFields.

    • getStoredFieldsCount

      int getStoredFieldsCount()
      repeated string stored_fields = 10 [json_name = "storedFields"];
      Returns:
      The count of storedFields.

    • getStoredFields

      String getStoredFields(int index)
      repeated string stored_fields = 10 [json_name = "storedFields"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The storedFields at the given index.

    • getStoredFieldsBytes

      com.google.protobuf.ByteString getStoredFieldsBytes(int index)
      repeated string stored_fields = 10 [json_name = "storedFields"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the storedFields at the given index.

    • hasVersion

      boolean hasVersion()
      optional int64 version = 11 [json_name = "version"];
      Returns:
      Whether the version field is set.

    • getVersion

      long getVersion()
      optional int64 version = 11 [json_name = "version"];
      Returns:
      The version.

    • hasVersionType

      boolean hasVersionType()
      optional .VersionType version_type = 12 [json_name = "versionType"];
      Returns:
      Whether the versionType field is set.

    • getVersionTypeValue

      int getVersionTypeValue()
      optional .VersionType version_type = 12 [json_name = "versionType"];
      Returns:
      The enum numeric value on the wire for versionType.

    • getVersionType

      VersionType getVersionType()
      optional .VersionType version_type = 12 [json_name = "versionType"];
      Returns:
      The versionType.

    • hasSourceType

      boolean hasSourceType()
      optional .SourceType source_type = 13 [json_name = "sourceType"];
      Returns:
      Whether the sourceType field is set.

    • getSourceTypeValue

      int getSourceTypeValue()
      optional .SourceType source_type = 13 [json_name = "sourceType"];
      Returns:
      The enum numeric value on the wire for sourceType.

    • getSourceType

      SourceType getSourceType()
      optional .SourceType source_type = 13 [json_name = "sourceType"];
      Returns:
      The sourceType.