@pulumi/github/getRepositoryPullRequest.d.ts

A Pulumi package for creating and managing github cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Use this data source to retrieve information about a specific GitHub Pull Request in a repository.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as github from "@pulumi/github";
 *
 * const example = github.getRepositoryPullRequest({
 *     baseRepository: "example_repository",
 *     number: 1,
 * });
 * ```
 */
export declare function getRepositoryPullRequest(args: GetRepositoryPullRequestArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryPullRequestResult>;
/**
 * A collection of arguments for invoking getRepositoryPullRequest.
 */
export interface GetRepositoryPullRequestArgs {
    /**
     * Name of the base repository to retrieve the Pull Request from.
     */
    baseRepository: string;
    /**
     * The number of the Pull Request within the repository.
     */
    number: number;
    /**
     * Owner of the repository. If not provided, the provider's default owner is used.
     */
    owner?: string;
}
/**
 * A collection of values returned by getRepositoryPullRequest.
 */
export interface GetRepositoryPullRequestResult {
    /**
     * Name of the ref (branch) of the Pull Request base.
     */
    readonly baseRef: string;
    readonly baseRepository: string;
    /**
     * Head commit SHA of the Pull Request base.
     */
    readonly baseSha: string;
    /**
     * Body of the Pull Request.
     */
    readonly body: string;
    /**
     * Indicates Whether this Pull Request is a draft.
     */
    readonly draft: boolean;
    /**
     * Owner of the Pull Request head repository.
     */
    readonly headOwner: string;
    readonly headRef: string;
    /**
     * Name of the Pull Request head repository.
     */
    readonly headRepository: string;
    /**
     * Head commit SHA of the Pull Request head.
     */
    readonly headSha: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * List of label names set on the Pull Request.
     */
    readonly labels: string[];
    /**
     * Indicates whether the base repository maintainers can modify the Pull Request.
     */
    readonly maintainerCanModify: boolean;
    readonly number: number;
    /**
     * Unix timestamp indicating the Pull Request creation time.
     */
    readonly openedAt: number;
    /**
     * GitHub login of the user who opened the Pull Request.
     */
    readonly openedBy: string;
    readonly owner?: string;
    /**
     * the current Pull Request state - can be "open", "closed" or "merged".
     */
    readonly state: string;
    /**
     * The title of the Pull Request.
     */
    readonly title: string;
    /**
     * The timestamp of the last Pull Request update.
     */
    readonly updatedAt: number;
}
/**
 * Use this data source to retrieve information about a specific GitHub Pull Request in a repository.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as github from "@pulumi/github";
 *
 * const example = github.getRepositoryPullRequest({
 *     baseRepository: "example_repository",
 *     number: 1,
 * });
 * ```
 */
export declare function getRepositoryPullRequestOutput(args: GetRepositoryPullRequestOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRepositoryPullRequestResult>;
/**
 * A collection of arguments for invoking getRepositoryPullRequest.
 */
export interface GetRepositoryPullRequestOutputArgs {
    /**
     * Name of the base repository to retrieve the Pull Request from.
     */
    baseRepository: pulumi.Input<string>;
    /**
     * The number of the Pull Request within the repository.
     */
    number: pulumi.Input<number>;
    /**
     * Owner of the repository. If not provided, the provider's default owner is used.
     */
    owner?: pulumi.Input<string>;
}