Struct octorust::types::ReposCreateDeploymentRequest

pub struct ReposCreateDeploymentRequest {
    pub auto_merge: bool,
    pub description: String,
    pub environment: String,
    pub payload: Option<ReposCreateDeploymentRequestPayloadOneOf>,
    pub production_environment: bool,
    pub ref_: String,
    pub required_contexts: Vec<String>,
    pub task: String,
    pub transient_environment: bool,
}

Fields

auto_merge: bool

Attempts to automatically merge the default branch into the requested ref, if it’s behind the default branch.

description: String

Short description of the deployment.

environment: String

Name for the target deployment environment (e.g., production, staging, qa).

payload: Option<ReposCreateDeploymentRequestPayloadOneOf>

One of the following types:

• Data
• String

You can easily convert this enum to the inner value with From and Into, as both are implemented for each type.

production_environment: bool

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
**Note:** This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

ref_: String

The ref to deploy. This can be a branch, tag, or SHA.

required_contexts: Vec<String>

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

task: String

Specifies a task to execute (e.g., deploy or deploy:migrations).

transient_environment: bool

Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false
**Note:** This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

Trait Implementations

impl Clone for ReposCreateDeploymentRequest

fn clone(&self) -> ReposCreateDeploymentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReposCreateDeploymentRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReposCreateDeploymentRequest

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ReposCreateDeploymentRequest

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 ReposCreateDeploymentRequest

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

Serialize this value into the given Serde serializer.