appc-client/client-kit/src/main/java/org/onap/appc/client/lcm/model/CommonHeader.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 /**
  26  * NOTE: This file is auto-generated and should not be changed manually.
  27  */
  28 package org.onap.appc.client.lcm.model;
  29
  30 import com.fasterxml.jackson.annotation.JsonProperty;
  31
  32 /**
  33  * A common header for all APP-C requests
  34  */
  35 @javax.annotation.Generated(
  36     value = {"client-kit/open-api-to-java.ftl"},
  37     date = "2017-11-16T17:10:10.312Z",
  38     comments = "Auto-generated from Open API specification")
  39 public class CommonHeader {
  40
  41     @JsonProperty("timestamp")
  42     private ZULU timestamp;
  43
  44     @JsonProperty("api-ver")
  45     private String apiVer;
  46
  47     @JsonProperty("originator-id")
  48     private String originatorId;
  49
  50     @JsonProperty("request-id")
  51     private String requestId;
  52
  53     @JsonProperty("sub-request-id")
  54     private String subRequestId;
  55
  56     @JsonProperty("flags")
  57     private Flags flags;
  58
  59     /**
  60      * Define a common definition of a time stamp (expressed as a formatted string) as follows yyyy-MM-ddTHH:mm:ss.SSSSSSSSZ
  61      */
  62     public ZULU getTimestamp() {
  63         return timestamp;
  64     }
  65
  66     /**
  67      * Define a common definition of a time stamp (expressed as a formatted string) as follows yyyy-MM-ddTHH:mm:ss.SSSSSSSSZ
  68      */
  69     public void setTimestamp(ZULU timestamp) {
  70         this.timestamp = timestamp;
  71     }
  72
  73     /**
  74      * api-ver is the API version identifier. A given release of APPC should support all previous versions of APPC API (correlate with general requirements)
  75      */
  76     public String getApiVer() {
  77         return apiVer;
  78     }
  79
  80     /**
  81      * api-ver is the API version identifier. A given release of APPC should support all previous versions of APPC API (correlate with general requirements)
  82      */
  83     public void setApiVer(String apiVer) {
  84         this.apiVer = apiVer;
  85     }
  86
  87     /**
  88      * originator-id an identifier of the calling system which can be used addressing purposes, i.e. returning asynchronous response to the proper destination over DMaaP (especially in case of multiple consumers of APP-C APIs)
  89      */
  90     public String getOriginatorId() {
  91         return originatorId;
  92     }
  93
  94     /**
  95      * originator-id an identifier of the calling system which can be used addressing purposes, i.e. returning asynchronous response to the proper destination over DMaaP (especially in case of multiple consumers of APP-C APIs)
  96      */
  97     public void setOriginatorId(String originatorId) {
  98         this.originatorId = originatorId;
  99     }
 100
 101     /**
 102      * UUID for the request ID. An OSS/BSS identifier for the request that caused the current action. Multiple API calls may be made with the same request-id The request-id shall be recorded throughout the operations on a single request
 103      */
 104     public String getRequestId() {
 105         return requestId;
 106     }
 107
 108     /**
 109      * UUID for the request ID. An OSS/BSS identifier for the request that caused the current action. Multiple API calls may be made with the same request-id The request-id shall be recorded throughout the operations on a single request
 110      */
 111     public void setRequestId(String requestId) {
 112         this.requestId = requestId;
 113     }
 114
 115     /**
 116      * Uniquely identifies a specific LCM action. It is persistent over the life-cycle of a single request
 117      */
 118     public String getSubRequestId() {
 119         return subRequestId;
 120     }
 121
 122     /**
 123      * Uniquely identifies a specific LCM action. It is persistent over the life-cycle of a single request
 124      */
 125     public void setSubRequestId(String subRequestId) {
 126         this.subRequestId = subRequestId;
 127     }
 128
 129     /**
 130      * Flags are generic flags that apply to any and all commands, all are optional
 131      */
 132     public Flags getFlags() {
 133         return flags;
 134     }
 135
 136     /**
 137      * Flags are generic flags that apply to any and all commands, all are optional
 138      */
 139     public void setFlags(Flags flags) {
 140         this.flags = flags;
 141     }
 142
 143 }