Package org.opensearch.index.reindex

Class RemoteInfo

java.lang.Object
org.opensearch.index.reindex.RemoteInfo
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
public class RemoteInfo extends Object implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentObject
Encapsulates informatoin for remote resources
Opensearch.internal:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.opensearch.common.unit.TimeValue
    DEFAULT_CONNECT_TIMEOUT
    Default connectTimeout for requests that don't have one set.
    static final org.opensearch.common.unit.TimeValue
    DEFAULT_SOCKET_TIMEOUT
    Default socketTimeout for requests that don't have one set.
    static final org.opensearch.core.xcontent.XContent
    QUERY_CONTENT_TYPE
     

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RemoteInfo(String scheme, String host, int port, String pathPrefix, org.opensearch.core.common.bytes.BytesReference query, String username, String password, Map<String,String> headers, org.opensearch.common.unit.TimeValue socketTimeout, org.opensearch.common.unit.TimeValue connectTimeout)
     
    RemoteInfo(org.opensearch.core.common.io.stream.StreamInput in)
    Read from a stream.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    org.opensearch.common.unit.TimeValue
    getConnectTimeout()
    Time to wait to connect to the external cluster.
    Map<String,String>
    getHeaders()
     
    String
    getHost()
     
    String
    getPassword()
     
    String
    getPathPrefix()
     
    int
    getPort()
     
    org.opensearch.core.common.bytes.BytesReference
    getQuery()
     
    String
    getScheme()
     
    org.opensearch.common.unit.TimeValue
    getSocketTimeout()
    Time to wait for a response from each request.
    String
    getUsername()
     
    int
    hashCode()
     
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Field Details

    • DEFAULT_SOCKET_TIMEOUT

      public static final org.opensearch.common.unit.TimeValue DEFAULT_SOCKET_TIMEOUT
      Default socketTimeout for requests that don't have one set.

    • DEFAULT_CONNECT_TIMEOUT

      public static final org.opensearch.common.unit.TimeValue DEFAULT_CONNECT_TIMEOUT
      Default connectTimeout for requests that don't have one set.

    • QUERY_CONTENT_TYPE

      public static final org.opensearch.core.xcontent.XContent QUERY_CONTENT_TYPE

  • Constructor Details

    • RemoteInfo

      public RemoteInfo(String scheme, String host, int port, String pathPrefix, org.opensearch.core.common.bytes.BytesReference query, String username, String password, Map<String,String> headers, org.opensearch.common.unit.TimeValue socketTimeout, org.opensearch.common.unit.TimeValue connectTimeout)

    • RemoteInfo

      public RemoteInfo(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Read from a stream.
      Throws:
      IOException

  • Method Details

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • getScheme

      public String getScheme()

    • getHost

      public String getHost()

    • getPort

      public int getPort()

    • getPathPrefix

      @Nullable public String getPathPrefix()

    • getQuery

      public org.opensearch.core.common.bytes.BytesReference getQuery()

    • getUsername

      @Nullable public String getUsername()

    • getPassword

      @Nullable public String getPassword()

    • getHeaders

      public Map<String,String> getHeaders()

    • getSocketTimeout

      public org.opensearch.common.unit.TimeValue getSocketTimeout()
      Time to wait for a response from each request.

    • getConnectTimeout

      public org.opensearch.common.unit.TimeValue getConnectTimeout()
      Time to wait to connect to the external cluster.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object