IndexerCurrentState.java

  1. // Copyright (c) Microsoft Corporation. All rights reserved.
  2. // Licensed under the MIT License.
  3. //
  4. // Code generated by Microsoft (R) AutoRest Code Generator.
  5. // Changes may cause incorrect behavior and will be lost if the code is
  6. // regenerated.

  7. package com.azure.search.documents.indexes.models;

  8. import com.azure.core.annotation.Immutable;
  9. import com.fasterxml.jackson.annotation.JsonProperty;
  10. import java.util.List;

  11. /** Represents all of the state that defines and dictates the indexer's current execution. */
  12. @Immutable
  13. public final class IndexerCurrentState {
  14.     /*
  15.      * The mode the indexer is running in.
  16.      */
  17.     @JsonProperty(value = "mode", access = JsonProperty.Access.WRITE_ONLY)
  18.     private IndexingMode mode;

  19.     /*
  20.      * Change tracking state used when indexing starts on all documents in the
  21.      * datasource.
  22.      */
  23.     @JsonProperty(value = "allDocsInitialChangeTrackingState", access = JsonProperty.Access.WRITE_ONLY)
  24.     private String allDocsInitialChangeTrackingState;

  25.     /*
  26.      * Change tracking state value when indexing finishes on all documents in
  27.      * the datasource.
  28.      */
  29.     @JsonProperty(value = "allDocsFinalChangeTrackingState", access = JsonProperty.Access.WRITE_ONLY)
  30.     private String allDocsFinalChangeTrackingState;

  31.     /*
  32.      * Change tracking state used when indexing starts on select, reset
  33.      * documents in the datasource.
  34.      */
  35.     @JsonProperty(value = "resetDocsInitialChangeTrackingState", access = JsonProperty.Access.WRITE_ONLY)
  36.     private String resetDocsInitialChangeTrackingState;

  37.     /*
  38.      * Change tracking state value when indexing finishes on select, reset
  39.      * documents in the datasource.
  40.      */
  41.     @JsonProperty(value = "resetDocsFinalChangeTrackingState", access = JsonProperty.Access.WRITE_ONLY)
  42.     private String resetDocsFinalChangeTrackingState;

  43.     /*
  44.      * The list of document keys that have been reset. The document key is the
  45.      * document's unique identifier for the data in the search index. The
  46.      * indexer will prioritize selectively re-ingesting these keys.
  47.      */
  48.     @JsonProperty(value = "resetDocumentKeys", access = JsonProperty.Access.WRITE_ONLY)
  49.     private List<String> resetDocumentKeys;

  50.     /*
  51.      * The list of datasource document ids that have been reset. The datasource
  52.      * document id is the unique identifier for the data in the datasource. The
  53.      * indexer will prioritize selectively re-ingesting these ids.
  54.      */
  55.     @JsonProperty(value = "resetDatasourceDocumentIds", access = JsonProperty.Access.WRITE_ONLY)
  56.     private List<String> resetDatasourceDocumentIds;

  57.     /**
  58.      * Get the mode property: The mode the indexer is running in.
  59.      *
  60.      * @return the mode value.
  61.      */
  62.     public IndexingMode getMode() {
  63.         return this.mode;
  64.     }

  65.     /**
  66.      * Get the allDocsInitialChangeTrackingState property: Change tracking state used when indexing starts on all
  67.      * documents in the datasource.
  68.      *
  69.      * @return the allDocsInitialChangeTrackingState value.
  70.      */
  71.     public String getAllDocsInitialChangeTrackingState() {
  72.         return this.allDocsInitialChangeTrackingState;
  73.     }

  74.     /**
  75.      * Get the allDocsFinalChangeTrackingState property: Change tracking state value when indexing finishes on all
  76.      * documents in the datasource.
  77.      *
  78.      * @return the allDocsFinalChangeTrackingState value.
  79.      */
  80.     public String getAllDocsFinalChangeTrackingState() {
  81.         return this.allDocsFinalChangeTrackingState;
  82.     }

  83.     /**
  84.      * Get the resetDocsInitialChangeTrackingState property: Change tracking state used when indexing starts on select,
  85.      * reset documents in the datasource.
  86.      *
  87.      * @return the resetDocsInitialChangeTrackingState value.
  88.      */
  89.     public String getResetDocsInitialChangeTrackingState() {
  90.         return this.resetDocsInitialChangeTrackingState;
  91.     }

  92.     /**
  93.      * Get the resetDocsFinalChangeTrackingState property: Change tracking state value when indexing finishes on select,
  94.      * reset documents in the datasource.
  95.      *
  96.      * @return the resetDocsFinalChangeTrackingState value.
  97.      */
  98.     public String getResetDocsFinalChangeTrackingState() {
  99.         return this.resetDocsFinalChangeTrackingState;
  100.     }

  101.     /**
  102.      * Get the resetDocumentKeys property: The list of document keys that have been reset. The document key is the
  103.      * document's unique identifier for the data in the search index. The indexer will prioritize selectively
  104.      * re-ingesting these keys.
  105.      *
  106.      * @return the resetDocumentKeys value.
  107.      */
  108.     public List<String> getResetDocumentKeys() {
  109.         return this.resetDocumentKeys;
  110.     }

  111.     /**
  112.      * Get the resetDatasourceDocumentIds property: The list of datasource document ids that have been reset. The
  113.      * datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize
  114.      * selectively re-ingesting these ids.
  115.      *
  116.      * @return the resetDatasourceDocumentIds value.
  117.      */
  118.     public List<String> getResetDatasourceDocumentIds() {
  119.         return this.resetDatasourceDocumentIds;
  120.     }
  121. }