org.heigit.ohsome.ohsomeapi.output.Metadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ohsome-api Show documentation

A public Web-RESTful-API for "ohsome" OpenStreetMap history data.

The newest version!

package org.heigit.ohsome.ohsomeapi.output;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import io.swagger.annotations.ApiModelProperty;

/**
 * Represents the metadata JSON object containing the execution time, a description of the result
 * values, as well as the request URL.
 */
@JsonInclude(Include.NON_NULL)
public class Metadata {
  @ApiModelProperty(notes = "Time the server needed to execute the request", required = true)
  private Long executionTime;
  @ApiModelProperty(notes = "Text describing the result in a sentence", required = true)
  private String description;
  @ApiModelProperty(notes = "Request URL to which this whole output JSON was generated", required = true)
  private String requestUrl;

  @java.lang.SuppressWarnings("all")
  public Long getExecutionTime() {
    return this.executionTime;
  }

  @java.lang.SuppressWarnings("all")
  public String getDescription() {
    return this.description;
  }

  @java.lang.SuppressWarnings("all")
  public String getRequestUrl() {
    return this.requestUrl;
  }

  @java.lang.SuppressWarnings("all")
  public Metadata(final Long executionTime, final String description, final String requestUrl) {
    this.executionTime = executionTime;
    this.description = description;
    this.requestUrl = requestUrl;
  }
}