/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.iot.model; import java.io.Serializable; public class DescribeIndexResult implements Serializable { /** *
* The index name. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
*/
private String indexName;
/**
*
* The index status. *
*
* Constraints:
* Allowed Values: ACTIVE, BUILDING, REBUILDING
*/
private String indexStatus;
/**
*
* Contains a value that specifies the type of indexing performed. Valid * values are: *
** REGISTRY – Your thing index contains only registry data. *
** REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow * data. *
** REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry * data and thing connectivity status data. *
** REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains * registry data, shadow data, and thing connectivity status data. *
** MULTI_INDEXING_MODE - Your thing index contains multiple data sources. * For more information, see GetIndexingConfiguration. *
** The index name. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
*
* @return
* The index name. *
*/ public String getIndexName() { return indexName; } /** ** The index name. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
*
* @param indexName
* The index name. *
*/ public void setIndexName(String indexName) { this.indexName = indexName; } /** ** The index name. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
*
* @param indexName
* The index name. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeIndexResult withIndexName(String indexName) { this.indexName = indexName; return this; } /** ** The index status. *
*
* Constraints:
* Allowed Values: ACTIVE, BUILDING, REBUILDING
*
* @return
* The index status. *
* @see IndexStatus */ public String getIndexStatus() { return indexStatus; } /** ** The index status. *
*
* Constraints:
* Allowed Values: ACTIVE, BUILDING, REBUILDING
*
* @param indexStatus
* The index status. *
* @see IndexStatus */ public void setIndexStatus(String indexStatus) { this.indexStatus = indexStatus; } /** ** The index status. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: ACTIVE, BUILDING, REBUILDING
*
* @param indexStatus
* The index status. *
* @return A reference to this updated object so that method calls can be * chained together. * @see IndexStatus */ public DescribeIndexResult withIndexStatus(String indexStatus) { this.indexStatus = indexStatus; return this; } /** ** The index status. *
*
* Constraints:
* Allowed Values: ACTIVE, BUILDING, REBUILDING
*
* @param indexStatus
* The index status. *
* @see IndexStatus */ public void setIndexStatus(IndexStatus indexStatus) { this.indexStatus = indexStatus.toString(); } /** ** The index status. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: ACTIVE, BUILDING, REBUILDING
*
* @param indexStatus
* The index status. *
* @return A reference to this updated object so that method calls can be * chained together. * @see IndexStatus */ public DescribeIndexResult withIndexStatus(IndexStatus indexStatus) { this.indexStatus = indexStatus.toString(); return this; } /** ** Contains a value that specifies the type of indexing performed. Valid * values are: *
** REGISTRY – Your thing index contains only registry data. *
** REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow * data. *
** REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry * data and thing connectivity status data. *
** REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains * registry data, shadow data, and thing connectivity status data. *
** MULTI_INDEXING_MODE - Your thing index contains multiple data sources. * For more information, see GetIndexingConfiguration. *
** Contains a value that specifies the type of indexing performed. * Valid values are: *
** REGISTRY – Your thing index contains only registry data. *
** REGISTRY_AND_SHADOW - Your thing index contains registry data and * shadow data. *
** REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains * registry data and thing connectivity status data. *
** REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index * contains registry data, shadow data, and thing connectivity * status data. *
** MULTI_INDEXING_MODE - Your thing index contains multiple data * sources. For more information, see GetIndexingConfiguration. *
** Contains a value that specifies the type of indexing performed. Valid * values are: *
** REGISTRY – Your thing index contains only registry data. *
** REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow * data. *
** REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry * data and thing connectivity status data. *
** REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains * registry data, shadow data, and thing connectivity status data. *
** MULTI_INDEXING_MODE - Your thing index contains multiple data sources. * For more information, see GetIndexingConfiguration. *
** Contains a value that specifies the type of indexing * performed. Valid values are: *
** REGISTRY – Your thing index contains only registry data. *
** REGISTRY_AND_SHADOW - Your thing index contains registry data * and shadow data. *
** REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains * registry data and thing connectivity status data. *
** REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index * contains registry data, shadow data, and thing connectivity * status data. *
** MULTI_INDEXING_MODE - Your thing index contains multiple data * sources. For more information, see GetIndexingConfiguration. *
** Contains a value that specifies the type of indexing performed. Valid * values are: *
** REGISTRY – Your thing index contains only registry data. *
** REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow * data. *
** REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry * data and thing connectivity status data. *
** REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains * registry data, shadow data, and thing connectivity status data. *
** MULTI_INDEXING_MODE - Your thing index contains multiple data sources. * For more information, see GetIndexingConfiguration. *
** Returns a reference to this object so that method calls can be chained * together. * * @param schema
* Contains a value that specifies the type of indexing * performed. Valid values are: *
** REGISTRY – Your thing index contains only registry data. *
** REGISTRY_AND_SHADOW - Your thing index contains registry data * and shadow data. *
** REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains * registry data and thing connectivity status data. *
** REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index * contains registry data, shadow data, and thing connectivity * status data. *
** MULTI_INDEXING_MODE - Your thing index contains multiple data * sources. For more information, see GetIndexingConfiguration. *
*