models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaProperty.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy Model
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019-2020 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.models.tosca.authorative.concepts;
  25
  26 import com.google.gson.annotations.SerializedName;
  27 import io.swagger.annotations.ApiModelProperty;
  28 import java.util.List;
  29 import java.util.Map;
  30 import lombok.Data;
  31
  32 /**
  33  * Class to represent TOSCA property matching input/output from/to client.
  34  *
  35  * @author Chenfei Gao (cgao@research.att.com)
  36  */
  37 @Data
  38 public class ToscaProperty {
  39     public enum Status {
  40         SUPPORTED, UNSUPPORTED, EXPERIMENTAL, DEPRECATED
  41     }
  42
  43     private String name;
  44     private String type;
  45
  46     @ApiModelProperty(name = "type_version")
  47     @SerializedName("type_version")
  48     private String typeVersion;
  49
  50     private String description;
  51
  52     @ApiModelProperty(name = "default")
  53     @SerializedName("default")
  54     private Object defaultValue;
  55
  56     private boolean required = false;
  57     private Status status;
  58     private List<ToscaConstraint> constraints;
  59
  60     @ApiModelProperty(name = "key_schema")
  61     @SerializedName("key_schema")
  62     private ToscaSchemaDefinition keySchema;
  63
  64     @ApiModelProperty(name = "entry_schema")
  65     @SerializedName("entry_schema")
  66     private ToscaSchemaDefinition entrySchema;
  67
  68     private Map<String, String> metadata;
  69 }