OctopusDeployment Class

Summary

An object representing a deployment in Octopus Deploy.
Namespace
Cake.Common.Tools.OctopusDeploy
Base Types
  • object
graph BT Type-->Base0["object"] Type["OctopusDeployment"] class Type type-node

Syntax

public class OctopusDeployment

Properties

Name Value Summary
Assembled DateTimeOffset
gets or sets when the deployment was assembled.
Channel string
gets or sets the Deployment's channel.
Created DateTimeOffset
gets or sets When the deployment was created.
Environment string
gets or sets the Environment the project was deployed to.
PackageVersions string
gets or sets the list of packages in the deployment.
ProjectName string
gets or sets the Name of the Deployment's Project.
ReleaseNotesHtml string
gets or sets the release notes for the deployment (HTML Markup).
Version string
gets or sets the deployed project version.

Extension Methods

Name Value Summary
Dump<OctopusDeployment>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<OctopusDeployment>(OctopusDeployment[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<OctopusDeployment>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<OctopusDeployment>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<OctopusDeployment>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<OctopusDeployment>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin