com.spotify.github.v3.prs.AutoMerge 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.prs;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.spotify.github.GithubStyle;
import com.spotify.github.v3.User;
import org.immutables.value.Value;

import javax.annotation.Nullable;

@Value.Immutable
@GithubStyle
@JsonSerialize(as = ImmutableAutoMerge.class)
@JsonDeserialize(as = ImmutableAutoMerge.class)
public interface AutoMerge {
  // Who enabled the auto merge
  User enabledBy();

  // Merge Method chosen for the auto merge
  String mergeMethod();

  // The commit title to use when merging the pull request
  @Nullable
  String commitTitle();

  // The commit message to use when merging the pull request
  @Nullable
  String commitMessage();
}