com.spotify.github.v3.checks.CheckRunImage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of github-client Show documentation

The newest version!

/*-
 * -\-\-
 * github-api
 * --
 * Copyright (C) 2016 - 2020 Spotify AB
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -/-/-
 */

package com.spotify.github.v3.checks;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.spotify.github.GithubStyle;
import java.util.Optional;
import org.immutables.value.Value;

/**
 * The interface CheckRun image. Adds images to the output displayed in the GitHub pull request UI.
 */
@Value.Immutable
@GithubStyle
@JsonDeserialize(as = ImmutableCheckRunImage.class)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public interface CheckRunImage {

  /**
   * The alternative text for the image.
   *
   * @return the string
   */
  String alt();

  /**
   * The full URL of the image.
   *
   * @return the string
   */
  String imageUrl();

  /**
   * A short image description.
   *
   * @return the optional string
   */
  Optional caption();
}