Struct octorust::types::ReposCreateDeploymentStatusRequest

pub struct ReposCreateDeploymentStatusRequest {
    pub auto_inactive: Option<bool>,
    pub description: String,
    pub environment: Option<ReposCreateDeploymentStatusRequestEnvironment>,
    pub environment_url: String,
    pub log_url: String,
    pub state: ReposCreateDeploymentStatusRequestState,
    pub target_url: String,
}

Fields

auto_inactive: Option<bool>

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status’s deployment. An inactive status is only added to deployments that had a success state. Default: true
**Note:** To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type.
**Note:** This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

description: String

A short description of the status. The maximum description length is 140 characters.

environment: Option<ReposCreateDeploymentStatusRequestEnvironment>

Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. **Note:** This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.

environment_url: String

Sets the URL for accessing your environment. Default: ""
**Note:** This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

log_url: String

The full URL of the deployment’s output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: ""
**Note:** This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

state: ReposCreateDeploymentStatusRequestState

The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. **Note:** To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

target_url: String

The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It’s recommended to use the log_url parameter, which replaces target_url.

Trait Implementations

impl Clone for ReposCreateDeploymentStatusRequest

fn clone(&self) -> ReposCreateDeploymentStatusRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReposCreateDeploymentStatusRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReposCreateDeploymentStatusRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ReposCreateDeploymentStatusRequest

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ReposCreateDeploymentStatusRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.