aboutsummaryrefslogtreecommitdiffstats
path: root/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceRegistrationInfo.java
blob: 0f975c24c54509997007559009ef918ddd94f68f (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
/*-
 * ========================LICENSE_START=================================
 * ONAP : ccsdk oran
 * ======================================================================
 * Copyright (C) 2019-2020 Nordix Foundation. 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.ccsdk.oran.a1policymanagementservice.controllers.v2;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.annotations.SerializedName;

import io.swagger.v3.oas.annotations.media.Schema;

@Schema(name = "service_registration_info_v2", description = "Information for one service")
public class ServiceRegistrationInfo {

    @Schema(description = "identity of the service", required = true)
    @SerializedName("service_id")
    @JsonProperty("service_id")
    public String serviceId = "";

    @Schema(description = "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. "
            + "If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. "
            + "When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. "
            + "An unavailable service will be automatically deregistered and its policies will be deleted. "
            + "Value 0 means timeout supervision is disabled.")
    @SerializedName("keep_alive_interval_seconds")
    @JsonProperty("keep_alive_interval_seconds")
    public long keepAliveIntervalSeconds = 0;

    @Schema(description = "callback for notifying of Near-RT RIC state changes", required = false)
    @SerializedName("callback_url")
    @JsonProperty("callback_url")
    public String callbackUrl = "";

    public ServiceRegistrationInfo() {}

    public ServiceRegistrationInfo(String id, long keepAliveIntervalSeconds, String callbackUrl) {
        this.serviceId = id;
        this.keepAliveIntervalSeconds = keepAliveIntervalSeconds;
        this.callbackUrl = callbackUrl;
    }

}