com.arakelian.elastic.model.DocumentId Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.arakelian.elastic.model;

import com.arakelian.core.feature.Nullable;
import com.arakelian.elastic.Views.Elastic.Version6;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonView;

@JsonPropertyOrder({ "_index", "_type", "_id", "_shards", "_seq_no", "_primary_term" })
public interface DocumentId {
    @JsonProperty("_id")
    public String getId();

    @JsonProperty("_index")
    public String getIndex();

    @JsonProperty("_type")
    public String getType();

    @Nullable
    @JsonProperty("_seq_no")
    @JsonView(Version6.class)
    public Long getSeqNo();

    @Nullable
    @JsonProperty("_primary_term")
    @JsonView(Version6.class)
    public Integer getPrimaryTerm();

    @Nullable
    @JsonProperty("_shards")
    public Shards getShards();
}