com.spotify.github.v3.repos.FolderContent 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.repos;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.spotify.github.GithubStyle;
import com.spotify.github.v3.git.ShaLink;
import java.net.URI;
import javax.annotation.Nullable;
import org.immutables.value.Value;

/** Repository file content resource */
@Value.Immutable
@GithubStyle
@JsonSerialize(as = ImmutableFolderContent.class)
@JsonDeserialize(as = ImmutableFolderContent.class)
public interface FolderContent extends ShaLink {

  /** Content type. E.g file, dir, symlink, submodule */
  @Nullable
  String type();

  /** Content size in bytes */
  @Nullable
  Integer size();

  /** Content name. E.g. file name */
  @Nullable
  String name();

  /** The content path. */
  @Nullable
  String path();

  /** Git blob API URL */
  @Nullable
  URI gitUrl();

  /** Content URL */
  @Nullable
  URI htmlUrl();

  /** Content download URL */
  @Nullable
  URI downloadUrl();
}