aboutsummaryrefslogtreecommitdiffstats
path: root/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/RelationshipDict.java
blob: 007f371bef4f66e533e76199d8ff0640db4cfc9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
 * ============LICENSE_START=======================================================
 * PNF-REGISTRATION-HANDLER
 * ================================================================================
 * Copyright (C) 2018 NOKIA Intellectual Property. 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.
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.dcaegen2.services.prh.model;

import com.google.gson.annotations.SerializedName;
import org.immutables.gson.Gson;
import org.immutables.value.Value;
import org.springframework.lang.Nullable;

import java.util.Collections;
import java.util.List;

/**
 * RelationshipDict
 */
@Value.Immutable
@Gson.TypeAdapters(fieldNamingStrategy = true)
public interface RelationshipDict {

    /**
     * A keyword provided by A&AI to indicate type of node.
     **/
    @Nullable
    @SerializedName("related-to")
    String getRelatedTo();

    /**
     * The edge label for this relationship.
     **/
    @Nullable
    @SerializedName("relationship-label")
    String getRelationshipLabel();

    /**
     * URL to the object in A&AI.
     **/
    @Nullable
    @SerializedName("related-link")
    String getRelatedLink();

    /**
     * relationship Data
     **/
    @SerializedName("relationship-data")
    @Value.Default
    default List<RelationshipData> getRelationshipData() {
        return Collections.emptyList();
    }

}