aboutsummaryrefslogtreecommitdiffstats
path: root/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/AaiServiceInstanceResultModel.java
blob: 67d6ff90b2d0fdba99f589a31802c91c9e2a3178 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
 * ============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;

@Value.Immutable
@Gson.TypeAdapters(fieldNamingStrategy = true)
public interface AaiServiceInstanceResultModel {

    /**
     * Uniquely identifies this instance of a service
     **/
    @Nullable
    @SerializedName("service-instance-id")
    String getServiceInstanceId();

    /**
     * This field will store a name assigned to the service-instance.
     **/
    @Nullable
    @SerializedName("service-instance-name")
    String getServiceInstanceName();

    /**
     * String capturing type of service.
     **/
    @Nullable
    @SerializedName("service-type")
    String getServiceType();

    /**
     * String capturing the service role.
     **/
    @Nullable
    @SerializedName("service-role")
    String getServiceRole();

    /**
     * This field will store the environment context assigned to the service-instance.
    **/
    @Nullable
    @SerializedName("environment-context")
    String getEnvironmentContext();

    /**
     * This field will store the workload context assigned to the service-instance.
    **/
    @Nullable
    @SerializedName("workload-context")
    String getWorkloadContext();

    /**
     * createGson time of Network Service.
    **/
    @Nullable
    @SerializedName("created-at")
    String getCreatedAt();

    /**
     * last update of Network Service.
    **/
    @Nullable
    @SerializedName("updated-at")
    String getUpdatedAt();

    /**
     * short description for service-instance.
    **/
    @Nullable
    @SerializedName("description")
    String getDescription();

    /**
     * the ASDC model id for this resource or service model.
    **/
    @Nullable
    @SerializedName("model-invariant-id")
    String getModelInvariantId();

    /**
     * the ASDC model version for this resource or service model.
    **/
    @Nullable
    @SerializedName("model-version-id")
    String getModelVersionId();

    /**
     * the ASDC model version for this resource or service model.
    **/
    @Nullable
    @SerializedName("persona-model-version")
    String getPersonaModelVersion();

    /**
     * the ASDC data dictionary widget model. This maps directly to the A&AI widget.
    **/
    @Nullable
    @SerializedName("widget-model-id")
    String getWidgetModelId();

    /**
     * the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
    **/
    @Nullable
    @SerializedName("widget-model-version")
    String getWidgetModelVersion();

    /**
     * Indicates the total bandwidth to be used for this service.
    **/
    @Nullable
    @SerializedName("bandwidth-total")
    String getBandwidthTotal();

    /**
     * indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
    **/
    @Nullable
    @SerializedName("bandwidth-up-wan1")
    String getBandwidthUpWan1();

    /**
     * indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
    **/
    @Nullable
    @SerializedName("bandwidth-down-wan1")
    String getBandwidthDownWan1();

    /**
     * indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
    **/
    @Nullable
    @SerializedName("bandwidth-up-wan2")
    String getBandwidthUpWan2();

    /**
     * indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
    **/
    @Nullable
    @SerializedName("bandwidth-down-wan2")
    String getBandwidthDownWan2();

    /**
     * URL customers will use to access the vHN Portal.
    **/
    @Nullable
    @SerializedName("vhn-portal-url")
    String getVhnPortalUrl();

    /**
     * An identifier that customers assign to the location where this service is being used.
    **/
    @Nullable
    @SerializedName("service-instance-location-id")
    String getServiceInstanceLocationId();

    /**
     * Used for optimistic concurrency.  Must be empty on createGson, valid on update and delete.
    **/
    @Nullable
    @SerializedName("resource-version")
    String getResourceVersion();

    /**
     * Path to the controller object.
    **/
    @Nullable
    @SerializedName("selflink")
    String getSelflink();

    /**
     * Orchestration status of this service.
    **/
    @Nullable
    @SerializedName("orchestration-status")
    String getOrchestrationStatus();

    /**
     * Get relationshipList
    **/
    @SerializedName("relationship-list")
    @Value.Default
    default Relationship getRelationshipList() {
        return ImmutableRelationship.builder().build();
    }

}