common/onap-generic-artifact-browser/onap-generic-artifact-browser-service/src/main/java/org/onap/sdc/gab/model/GABQuery.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * GAB
   4  * ================================================================================
   5  * Copyright (C) 2019 Nokia Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.sdc.gab.model;
  22
  23 import java.util.Set;
  24 import lombok.AllArgsConstructor;
  25 import lombok.Getter;
  26
  27 /**
  28  * See GABQuery.{@link #fields}, GABQuery.{@link #document}
  29  */
  30 @AllArgsConstructor
  31 @Getter
  32 public class GABQuery {
  33
  34     /**
  35      * PATH - when provided path to the yaml file
  36      * CONTENT - when provided yaml file content
  37      */
  38     public enum GABQueryType {
  39         PATH, CONTENT
  40     }
  41
  42     /**
  43      * JSON paths for querying specific data (this will be the definition of a "column").
  44      */
  45     private Set<String> fields;
  46
  47     /**
  48      * An YAML document path/content
  49      */
  50     private String document;
  51
  52     /**
  53      * Used for query type checking.
  54      *
  55      * @see GABQueryType
  56      *
  57      */
  58     private GABQueryType type;
  59
  60 }