com.github.shredder121.gh_event_api.handler.status.StatusPayload Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Shredder121.
 *
 * 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.github.shredder121.gh_event_api.handler.status;

import java.time.ZonedDateTime;

import javax.validation.constraints.NotNull;

import com.fasterxml.jackson.databind.PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy;
import com.fasterxml.jackson.databind.annotation.JsonNaming;
import com.github.shredder121.gh_event_api.model.*;
import com.github.shredder121.gh_event_api.model.json.PropertyBasedJsonCreator;
import com.google.common.collect.ImmutableList;

/**
 * The payload passed when a {@code status} event is received.
 *
 * @author Shredder121
 * @see The status event on GitHub
 */
@lombok.Value
@JsonNaming(LowerCaseWithUnderscoresStrategy.class)
@lombok.AllArgsConstructor(
        access = lombok.AccessLevel.PACKAGE,
        onConstructor = @__(@PropertyBasedJsonCreator)
)
public class StatusPayload {

    /**
     * The id of the status, for GitHub bookkeeping.
     *
     */
    @NotNull Integer id;

    /**
     * The Commit SHA.
     */
    @NotNull String sha;

    /**
     * The name of the repository.
     */
    @NotNull String name;

    /**
     * The context of the status.
     */
    @NotNull String context;

    /**
     * The new state.
     */
    @NotNull String state;

    /**
     * The optional human-readable description added to the status.
     */
    String description;

    /**
     * The optional link added to the status.
     *
     */
    String targetUrl;

    /**
     * The commit that the status is for.
     */
    @NotNull StatusCommit commit;

    /**
     * A list of branch objects containing the commit.
     *
     * Each branch contains the given commit, but the commit may or may not be the head of the branch.
     *
     * The list includes a maximum of 10 branches.
     */
    @NotNull ImmutableList branches;

    /**
     * The date this status was generated.
     */
    @NotNull ZonedDateTime createdAt;

    /**
     * The date this status was last changed.
     */
    @NotNull ZonedDateTime updatedAt;

    /**
     * The repository of the status.
     */
    @NotNull Repository repository;

    /**
     * The organization the repository belongs to.
     * Only non-null with organization webhooks.
     */
    Organization organization;

    /**
     * The user that triggered the status change.
     */
    @NotNull User sender;
}