io.github.springwolf.asyncapi.v3.model.channel.ChannelParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of springwolf-asyncapi Show documentation

Springwolf implementation of the AsyncApi specification

There is a newer version: 1.9.0

// SPDX-License-Identifier: Apache-2.0
package io.github.springwolf.asyncapi.v3.model.channel;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.github.springwolf.asyncapi.v3.model.ExtendableObject;
import io.github.springwolf.asyncapi.v3.model.Reference;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;

import java.util.List;

/**
 * Describes a parameter included in a channel address.
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class ChannelParameter extends ExtendableObject implements Reference {
    /**
     * An enumeration of string values to be used if the substitution options are from a limited set.
     */
    @JsonProperty("enum")
    private List enumValues;

    /**
     * The default value to use for substitution, and to send, if an alternate value is not supplied.
     */
    @JsonProperty("default")
    private String defaultValue;

    /**
     * An optional description for the parameter. CommonMark syntax MAY be
     * used for rich text representation.
     */
    @JsonProperty(value = "description")
    private String description;

    /**
     * An array of examples of the parameter value.
     */
    @JsonProperty(value = "examples")
    private List examples;

    /**
     * A runtime expression that specifies the location of the parameter value.
     */
    @JsonProperty(value = "location")
    private String location;

    @JsonIgnore
    private String ref;

    @Override
    public String getRef() {
        return ref;
    }
}