Class IndexerRuntime

java.lang.Object
com.azure.search.documents.indexes.models.IndexerRuntime
All Implemented Interfaces:
com.azure.json.JsonSerializable<IndexerRuntime>
public final class IndexerRuntime extends Object implements com.azure.json.JsonSerializable<IndexerRuntime>
Represents the indexer's cumulative runtime consumption in the service.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexerRuntime(long usedSeconds, OffsetDateTime beginningTime, OffsetDateTime endingTime)
    Creates an instance of IndexerRuntime class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static IndexerRuntime
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of IndexerRuntime from the JsonReader.
    OffsetDateTime
    getBeginningTime()
    Get the beginningTime property: Beginning UTC time of the 24-hour period considered for indexer runtime usage (inclusive).
    OffsetDateTime
    getEndingTime()
    Get the endingTime property: End UTC time of the 24-hour period considered for indexer runtime usage (inclusive).
    Long
    getRemainingSeconds()
    Get the remainingSeconds property: Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds.
    long
    getUsedSeconds()
    Get the usedSeconds property: Cumulative runtime of the indexer from the beginningTime to endingTime, in seconds.
    IndexerRuntime
    setRemainingSeconds(Long remainingSeconds)
    Set the remainingSeconds property: Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • IndexerRuntime

      public IndexerRuntime(long usedSeconds, OffsetDateTime beginningTime, OffsetDateTime endingTime)
      Creates an instance of IndexerRuntime class.
      Parameters:
      usedSeconds - the usedSeconds value to set.
      beginningTime - the beginningTime value to set.
      endingTime - the endingTime value to set.

  • Method Details

    • getUsedSeconds

      public long getUsedSeconds()
      Get the usedSeconds property: Cumulative runtime of the indexer from the beginningTime to endingTime, in seconds.
      Returns:
      the usedSeconds value.

    • getRemainingSeconds

      public Long getRemainingSeconds()
      Get the remainingSeconds property: Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds.
      Returns:
      the remainingSeconds value.

    • setRemainingSeconds

      public IndexerRuntime setRemainingSeconds(Long remainingSeconds)
      Set the remainingSeconds property: Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds.
      Parameters:
      remainingSeconds - the remainingSeconds value to set.
      Returns:
      the IndexerRuntime object itself.

    • getBeginningTime

      public OffsetDateTime getBeginningTime()
      Get the beginningTime property: Beginning UTC time of the 24-hour period considered for indexer runtime usage (inclusive).
      Returns:
      the beginningTime value.

    • getEndingTime

      public OffsetDateTime getEndingTime()
      Get the endingTime property: End UTC time of the 24-hour period considered for indexer runtime usage (inclusive).
      Returns:
      the endingTime value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<IndexerRuntime>
      Throws:
      IOException

    • fromJson

      public static IndexerRuntime fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of IndexerRuntime from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of IndexerRuntime if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the IndexerRuntime.