SearchIndexerDataSourceConnection.java

  1. // Copyright (c) Microsoft Corporation. All rights reserved.
  2. // Licensed under the MIT License.

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

  6. import com.azure.core.annotation.Fluent;
  7. import com.fasterxml.jackson.annotation.JsonCreator;
  8. import com.fasterxml.jackson.annotation.JsonProperty;

  10. /**
  11.  * Represents a datasource definition, which can be used to configure an
  12.  * indexer.
  13.  */
  14. @Fluent
  15. public final class SearchIndexerDataSourceConnection {
  16.     /*
  17.      * The name of the datasource.
  18.      */
  19.     @JsonProperty(value = "name", required = true)
  20.     private String name;

  22.     /*
  23.      * The description of the datasource.
  24.      */
  25.     @JsonProperty(value = "description")
  26.     private String description;

  28.     /*
  29.      * The type of the datasource. Possible values include: 'AzureSql',
  30.      * 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'
  31.      */
  32.     @JsonProperty(value = "type", required = true)
  33.     private SearchIndexerDataSourceType type;

  35.     /*
  36.      * The connection string for the datasource.
  37.      */
  38.     @JsonProperty(value = "connectionString")
  39.     private String connectionString;

  41.     /*
  42.      * The data container for the datasource.
  43.      */
  44.     @JsonProperty(value = "container", required = true)
  45.     private SearchIndexerDataContainer container;

  47.     /*
  48.      * The data change detection policy for the datasource.
  49.      */
  50.     @JsonProperty(value = "dataChangeDetectionPolicy")
  51.     private DataChangeDetectionPolicy dataChangeDetectionPolicy;

  53.     /*
  54.      * The data deletion detection policy for the datasource.
  55.      */
  56.     @JsonProperty(value = "dataDeletionDetectionPolicy")
  57.     private DataDeletionDetectionPolicy dataDeletionDetectionPolicy;

  59.     /*
  60.      * The ETag of the data source.
  61.      */
  62.     @JsonProperty(value = "@odata.etag")
  63.     private String eTag;

  65.     /*
  66.      * A description of an encryption key that you create in Azure Key Vault.
  67.      * This key is used to provide an additional level of encryption-at-rest
  68.      * for your datasource definition when you want full assurance that no one,
  69.      * not even Microsoft, can decrypt your data source definition in Azure
  70.      * Cognitive Search. Once you have encrypted your data source definition,
  71.      * it will always remain encrypted. Azure Cognitive Search will ignore
  72.      * attempts to set this property to null. You can change this property as
  73.      * needed if you want to rotate your encryption key; Your datasource
  74.      * definition will be unaffected. Encryption with customer-managed keys is
  75.      * not available for free search services, and is only available for paid
  76.      * services created on or after January 1, 2019.
  77.      */
  78.     @JsonProperty(value = "encryptionKey")
  79.     private SearchResourceEncryptionKey encryptionKey;

  81.     /*
  82.      * An explicit managed identity to use for this datasource. If not
  83.      * specified and the connection string is a managed identity, the
  84.      * system-assigned managed identity is used. If not specified, the value
  85.      * remains unchanged. If "none" is specified, the value of this property is
  86.      * cleared.
  87.      */
  88.     @JsonProperty(value = "identity")
  89.     private SearchIndexerDataIdentity identity;

  91.     /**
  92.      * Constructor of {@link SearchIndexerDataSourceConnection}.
  93.      *
  94.      * @param name The name of the datasource.
  95.      */
  96.     public SearchIndexerDataSourceConnection(String name) {
  97.         this.name = name;
  98.     }

  100.     /**
  101.      * Constructor of {@link SearchIndexerDataSourceConnection}.
  102.      *
  103.      * @param name The name of the datasource.
  104.      * @param type The type of the datasource. Possible values include: 'AzureSql',
  105.      * 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'
  106.      * @param connectionString The connection string for the datasource.
  107.      * @param container The data container for the datasource.
  108.      */
  109.     @JsonCreator
  110.     public SearchIndexerDataSourceConnection(
  111.         @JsonProperty(value = "name") String name,
  112.         @JsonProperty(value = "type") SearchIndexerDataSourceType type,
  113.         @JsonProperty(value = "credentials") String connectionString,
  114.         @JsonProperty(value = "container") SearchIndexerDataContainer container) {
  115.         this.name = name;
  116.         this.type = type;
  117.         this.connectionString = connectionString;
  118.         this.container = container;
  119.     }

  121.     /**
  122.      * Get the name property: The name of the datasource.
  123.      *
  124.      * @return the name value.
  125.      */
  126.     public String getName() {
  127.         return this.name;
  128.     }

  130.     /**
  131.      * Get the description property: The description of the datasource.
  132.      *
  133.      * @return the description value.
  134.      */
  135.     public String getDescription() {
  136.         return this.description;
  137.     }

  139.     /**
  140.      * Set the description property: The description of the datasource.
  141.      *
  142.      * @param description the description value to set.
  143.      * @return the SearchIndexerDataSource object itself.
  144.      */
  145.     public SearchIndexerDataSourceConnection setDescription(String description) {
  146.         this.description = description;
  147.         return this;
  148.     }

  150.     /**
  151.      * Get the type property: The type of the datasource. Possible values
  152.      * include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'.
  153.      *
  154.      * @return the type value.
  155.      */
  156.     public SearchIndexerDataSourceType getType() {
  157.         return this.type;
  158.     }

  160.     /**
  161.      * Set the type property: The type of the datasource. Possible values
  162.      * include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'.
  163.      *
  164.      * @param type the type value to set.
  165.      * @return the SearchIndexerDataSource object itself.
  166.      */
  167.     public SearchIndexerDataSourceConnection setType(SearchIndexerDataSourceType type) {
  168.         this.type = type;
  169.         return this;
  170.     }

  172.     /**
  173.      * Get the connectionString property: The connection string for the
  174.      * datasource.
  175.      *
  176.      * @return the connectionString value.
  177.      */
  178.     public String getConnectionString() {
  179.         return this.connectionString;
  180.     }

  182.     /**
  183.      * Set the connectionString property: The connection string for the
  184.      * datasource.
  185.      *
  186.      * @param connectionString the connectionString value to set.
  187.      * @return the SearchIndexerDataSource object itself.
  188.      */
  189.     public SearchIndexerDataSourceConnection setConnectionString(String connectionString) {
  190.         this.connectionString = connectionString;
  191.         return this;
  192.     }

  194.     /**
  195.      * Get the container property: The data container for the datasource.
  196.      *
  197.      * @return the container value.
  198.      */
  199.     public SearchIndexerDataContainer getContainer() {
  200.         return this.container;
  201.     }

  203.     /**
  204.      * Set the container property: The data container for the datasource.
  205.      *
  206.      * @param container the container value to set.
  207.      * @return the SearchIndexerDataSource object itself.
  208.      */
  209.     public SearchIndexerDataSourceConnection setContainer(SearchIndexerDataContainer container) {
  210.         this.container = container;
  211.         return this;
  212.     }

  214.     /**
  215.      * Get the dataChangeDetectionPolicy property: The data change detection
  216.      * policy for the datasource.
  217.      *
  218.      * @return the dataChangeDetectionPolicy value.
  219.      */
  220.     public DataChangeDetectionPolicy getDataChangeDetectionPolicy() {
  221.         return this.dataChangeDetectionPolicy;
  222.     }

  224.     /**
  225.      * Set the dataChangeDetectionPolicy property: The data change detection
  226.      * policy for the datasource.
  227.      *
  228.      * @param dataChangeDetectionPolicy the dataChangeDetectionPolicy value to
  229.      * set.
  230.      * @return the SearchIndexerDataSource object itself.
  231.      */
  232.     public SearchIndexerDataSourceConnection setDataChangeDetectionPolicy(
  233.         DataChangeDetectionPolicy dataChangeDetectionPolicy) {
  234.         this.dataChangeDetectionPolicy = dataChangeDetectionPolicy;
  235.         return this;
  236.     }

  238.     /**
  239.      * Get the dataDeletionDetectionPolicy property: The data deletion
  240.      * detection policy for the datasource.
  241.      *
  242.      * @return the dataDeletionDetectionPolicy value.
  243.      */
  244.     public DataDeletionDetectionPolicy getDataDeletionDetectionPolicy() {
  245.         return this.dataDeletionDetectionPolicy;
  246.     }

  248.     /**
  249.      * Set the dataDeletionDetectionPolicy property: The data deletion
  250.      * detection policy for the datasource.
  251.      *
  252.      * @param dataDeletionDetectionPolicy the dataDeletionDetectionPolicy value
  253.      * to set.
  254.      * @return the SearchIndexerDataSource object itself.
  255.      */
  256.     public SearchIndexerDataSourceConnection setDataDeletionDetectionPolicy(
  257.         DataDeletionDetectionPolicy dataDeletionDetectionPolicy) {
  258.         this.dataDeletionDetectionPolicy = dataDeletionDetectionPolicy;
  259.         return this;
  260.     }

  262.     /**
  263.      * Get the eTag property: The ETag of the data source.
  264.      *
  265.      * @return the eTag value.
  266.      */
  267.     public String getETag() {
  268.         return this.eTag;
  269.     }

  271.     /**
  272.      * Set the eTag property: The ETag of the data source.
  273.      *
  274.      * @param eTag the eTag value to set.
  275.      * @return the SearchIndexerDataSource object itself.
  276.      */
  277.     public SearchIndexerDataSourceConnection setETag(String eTag) {
  278.         this.eTag = eTag;
  279.         return this;
  280.     }

  282.     /**
  283.      * Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key
  284.      * is used to provide an additional level of encryption-at-rest for your datasource definition when you want full
  285.      * assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search.
  286.      * Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will
  287.      * ignore attempts to set this property to null. You can change this property as needed if you want to rotate your
  288.      * encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not
  289.      * available for free search services, and is only available for paid services created on or after January 1, 2019.
  290.      *
  291.      * @return the encryptionKey value.
  292.      */
  293.     public SearchResourceEncryptionKey getEncryptionKey() {
  294.         return this.encryptionKey;
  295.     }

  297.     /**
  298.      * Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key
  299.      * is used to provide an additional level of encryption-at-rest for your datasource definition when you want full
  300.      * assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search.
  301.      * Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will
  302.      * ignore attempts to set this property to null. You can change this property as needed if you want to rotate your
  303.      * encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not
  304.      * available for free search services, and is only available for paid services created on or after January 1, 2019.
  305.      *
  306.      * @param encryptionKey the encryptionKey value to set.
  307.      * @return the SearchIndexerDataSource object itself.
  308.      */
  309.     public SearchIndexerDataSourceConnection setEncryptionKey(SearchResourceEncryptionKey encryptionKey) {
  310.         this.encryptionKey = encryptionKey;
  311.         return this;
  312.     }

  314.     /**
  315.      * Get the identity property: An explicit managed identity to use for this datasource. If not specified and the
  316.      * connection string is a managed identity, the system-assigned managed identity is used. If not specified, the
  317.      * value remains unchanged. If "none" is specified, the value of this property is cleared.
  318.      *
  319.      * @return the identity value.
  320.      */
  321.     public SearchIndexerDataIdentity getIdentity() {
  322.         return this.identity;
  323.     }

  325.     /**
  326.      * Set the identity property: An explicit managed identity to use for this datasource. If not specified and the
  327.      * connection string is a managed identity, the system-assigned managed identity is used. If not specified, the
  328.      * value remains unchanged. If "none" is specified, the value of this property is cleared.
  329.      *
  330.      * @param identity the identity value to set.
  331.      * @return the SearchIndexerDataSourceConnection object itself.
  332.      */
  333.     public SearchIndexerDataSourceConnection setIdentity(SearchIndexerDataIdentity identity) {
  334.         this.identity = identity;
  335.         return this;
  336.     }
  337. }
Created with JaCoCo 0.8.7.202105040129