Class CloudFoundryPushSettingsExtensions

Namespace

Nuke.Common.Tools.CloudFoundry

Assembly

Nuke.Common.dll

Used within CloudFoundryTasks.

public static class CloudFoundryPushSettingsExtensions

Inheritance

object

CloudFoundryPushSettingsExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

AddBuildpack<T>(T, IEnumerable<string>)

Adds values to Buildpack

Buildpack to be used

public static T AddBuildpack<T>(this T toolSettings, IEnumerable<string> buildpack) where T : CloudFoundryPushSettings

Parameters

toolSettings T

buildpack IEnumerable<string>

Returns

T

Type Parameters

T

AddBuildpack<T>(T, params string[])

Adds values to Buildpack

Buildpack to be used

public static T AddBuildpack<T>(this T toolSettings, params string[] buildpack) where T : CloudFoundryPushSettings

Parameters

toolSettings T

buildpack string[]

Returns

T

Type Parameters

T

AddVariable<T>(T, string, string)

Adds a new key-value-pair Variables

Variable key value pair for variable substitution in manifest

public static T AddVariable<T>(this T toolSettings, string variableKey, string variableValue) where T : CloudFoundryPushSettings

Parameters

toolSettings T

variableKey string

variableValue string

Returns

T

Type Parameters

T

ClearBuildpack<T>(T)

Clears Buildpack

Buildpack to be used

public static T ClearBuildpack<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ClearVariables<T>(T)

Clears Variables

Variable key value pair for variable substitution in manifest

public static T ClearVariables<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

DisableIgnoreManifest<T>(T)

Disables IgnoreManifest

Ignore manifest file

public static T DisableIgnoreManifest<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

DisableNoRoute<T>(T)

Disables NoRoute

Do not map a route to this app and remove routes from previous pushes of this app

public static T DisableNoRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

DisableNoStart<T>(T)

Disables NoStart

Do not start an app after pushing

public static T DisableNoStart<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

DisableRandomRoute<T>(T)

Disables RandomRoute

Create a random route for this app

public static T DisableRandomRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

EnableIgnoreManifest<T>(T)

Enables IgnoreManifest

Ignore manifest file

public static T EnableIgnoreManifest<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

EnableNoRoute<T>(T)

Enables NoRoute

Do not map a route to this app and remove routes from previous pushes of this app

public static T EnableNoRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

EnableNoStart<T>(T)

Enables NoStart

Do not start an app after pushing

public static T EnableNoStart<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

EnableRandomRoute<T>(T)

Enables RandomRoute

Create a random route for this app

public static T EnableRandomRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

RemoveBuildpack<T>(T, IEnumerable<string>)

Removes values from Buildpack

Buildpack to be used

public static T RemoveBuildpack<T>(this T toolSettings, IEnumerable<string> buildpack) where T : CloudFoundryPushSettings

Parameters

toolSettings T

buildpack IEnumerable<string>

Returns

T

Type Parameters

T

RemoveBuildpack<T>(T, params string[])

Removes values from Buildpack

Buildpack to be used

public static T RemoveBuildpack<T>(this T toolSettings, params string[] buildpack) where T : CloudFoundryPushSettings

Parameters

toolSettings T

buildpack string[]

Returns

T

Type Parameters

T

RemoveVariable<T>(T, string)

Removes a key-value-pair from Variables

Variable key value pair for variable substitution in manifest

public static T RemoveVariable<T>(this T toolSettings, string variableKey) where T : CloudFoundryPushSettings

Parameters

toolSettings T

variableKey string

Returns

T

Type Parameters

T

ResetAppName<T>(T)

Resets AppName

The name of the application.

public static T ResetAppName<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetCommand<T>(T)

Resets Command

Startup command

public static T ResetCommand<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetDockerImage<T>(T)

Resets DockerImage

Docker-image to be used (e.g. user/docker-image-name)

public static T ResetDockerImage<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetDockerUsername<T>(T)

Resets DockerUsername

Docker-image to be used (e.g. user/docker-image-name)

public static T ResetDockerUsername<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetDomain<T>(T)

Resets Domain

Specify a custom domain (e.g. private-domain.example.com, apps.internal.com) to use instead of the default domain

public static T ResetDomain<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetDroplet<T>(T)

Resets Droplet

Path to a tgz file with a pre-staged app

public static T ResetDroplet<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetHealthCheckType<T>(T)

Resets HealthCheckType

Application health check type

public static T ResetHealthCheckType<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetHostname<T>(T)

Resets Hostname

Hostname (e.g. my-subdomain)

public static T ResetHostname<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetIgnoreManifest<T>(T)

Resets IgnoreManifest

Ignore manifest file

public static T ResetIgnoreManifest<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetManifest<T>(T)

Resets Manifest

Path to manifest

public static T ResetManifest<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetNoRoute<T>(T)

Resets NoRoute

Do not map a route to this app and remove routes from previous pushes of this app

public static T ResetNoRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetNoStart<T>(T)

Resets NoStart

Do not start an app after pushing

public static T ResetNoStart<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetPath<T>(T)

Resets Path

Path to app directory or to a zip file of the contents of the app directory

public static T ResetPath<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetRandomRoute<T>(T)

Resets RandomRoute

Create a random route for this app

public static T ResetRandomRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetRoutePath<T>(T)

Resets RoutePath

Path for the route

public static T ResetRoutePath<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetStack<T>(T)

Resets Stack

Stack to use (a stack is a pre-built file system, including an operating system, that can run apps)

public static T ResetStack<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetStartupTimeout<T>(T)

Resets StartupTimeout

Time (in seconds) allowed to elapse between starting up an app and the first healthy response from the app

public static T ResetStartupTimeout<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ResetVariablesFile<T>(T)

Resets VariablesFile

Path to a variable substitution file for manifest; can specify multiple times

public static T ResetVariablesFile<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

SetAppName<T>(T, string)

Sets AppName

The name of the application.

public static T SetAppName<T>(this T toolSettings, string appName) where T : CloudFoundryPushSettings

Parameters

toolSettings T

appName string

Returns

T

Type Parameters

T

SetBuildpack<T>(T, IEnumerable<string>)

Sets Buildpack to a new list

Buildpack to be used

public static T SetBuildpack<T>(this T toolSettings, IEnumerable<string> buildpack) where T : CloudFoundryPushSettings

Parameters

toolSettings T

buildpack IEnumerable<string>

Returns

T

Type Parameters

T

SetBuildpack<T>(T, params string[])

Sets Buildpack to a new list

Buildpack to be used

public static T SetBuildpack<T>(this T toolSettings, params string[] buildpack) where T : CloudFoundryPushSettings

Parameters

toolSettings T

buildpack string[]

Returns

T

Type Parameters

T

SetCommand<T>(T, string)

Sets Command

Startup command

public static T SetCommand<T>(this T toolSettings, string command) where T : CloudFoundryPushSettings

Parameters

toolSettings T

command string

Returns

T

Type Parameters

T

SetDockerImage<T>(T, string)

Sets DockerImage

Docker-image to be used (e.g. user/docker-image-name)

public static T SetDockerImage<T>(this T toolSettings, string dockerImage) where T : CloudFoundryPushSettings

Parameters

toolSettings T

dockerImage string

Returns

T

Type Parameters

T

SetDockerUsername<T>(T, string)

Sets DockerUsername

Docker-image to be used (e.g. user/docker-image-name)

public static T SetDockerUsername<T>(this T toolSettings, string dockerUsername) where T : CloudFoundryPushSettings

Parameters

toolSettings T

dockerUsername string

Returns

T

Type Parameters

T

SetDomain<T>(T, string)

Sets Domain

Specify a custom domain (e.g. private-domain.example.com, apps.internal.com) to use instead of the default domain

public static T SetDomain<T>(this T toolSettings, string domain) where T : CloudFoundryPushSettings

Parameters

toolSettings T

domain string

Returns

T

Type Parameters

T

SetDroplet<T>(T, string)

Sets Droplet

Path to a tgz file with a pre-staged app

public static T SetDroplet<T>(this T toolSettings, string droplet) where T : CloudFoundryPushSettings

Parameters

toolSettings T

droplet string

Returns

T

Type Parameters

T

SetHealthCheckType<T>(T, HealthCheckType)

Sets HealthCheckType

Application health check type

public static T SetHealthCheckType<T>(this T toolSettings, HealthCheckType healthCheckType) where T : CloudFoundryPushSettings

Parameters

toolSettings T

healthCheckType HealthCheckType

Returns

T

Type Parameters

T

SetHostname<T>(T, string)

Sets Hostname

Hostname (e.g. my-subdomain)

public static T SetHostname<T>(this T toolSettings, string hostname) where T : CloudFoundryPushSettings

Parameters

toolSettings T

hostname string

Returns

T

Type Parameters

T

SetIgnoreManifest<T>(T, bool?)

Sets IgnoreManifest

Ignore manifest file

public static T SetIgnoreManifest<T>(this T toolSettings, bool? ignoreManifest) where T : CloudFoundryPushSettings

Parameters

toolSettings T

ignoreManifest bool?

Returns

T

Type Parameters

T

SetManifest<T>(T, string)

Sets Manifest

Path to manifest

public static T SetManifest<T>(this T toolSettings, string manifest) where T : CloudFoundryPushSettings

Parameters

toolSettings T

manifest string

Returns

T

Type Parameters

T

SetNoRoute<T>(T, bool?)

Sets NoRoute

Do not map a route to this app and remove routes from previous pushes of this app

public static T SetNoRoute<T>(this T toolSettings, bool? noRoute) where T : CloudFoundryPushSettings

Parameters

toolSettings T

noRoute bool?

Returns

T

Type Parameters

T

SetNoStart<T>(T, bool?)

Sets NoStart

Do not start an app after pushing

public static T SetNoStart<T>(this T toolSettings, bool? noStart) where T : CloudFoundryPushSettings

Parameters

toolSettings T

noStart bool?

Returns

T

Type Parameters

T

SetPath<T>(T, string)

Sets Path

Path to app directory or to a zip file of the contents of the app directory

public static T SetPath<T>(this T toolSettings, string path) where T : CloudFoundryPushSettings

Parameters

toolSettings T

path string

Returns

T

Type Parameters

T

SetRandomRoute<T>(T, bool?)

Sets RandomRoute

Create a random route for this app

public static T SetRandomRoute<T>(this T toolSettings, bool? randomRoute) where T : CloudFoundryPushSettings

Parameters

toolSettings T

randomRoute bool?

Returns

T

Type Parameters

T

SetRoutePath<T>(T, string)

Sets RoutePath

Path for the route

public static T SetRoutePath<T>(this T toolSettings, string routePath) where T : CloudFoundryPushSettings

Parameters

toolSettings T

routePath string

Returns

T

Type Parameters

T

SetStack<T>(T, Stack)

Sets Stack

Stack to use (a stack is a pre-built file system, including an operating system, that can run apps)

public static T SetStack<T>(this T toolSettings, Stack stack) where T : CloudFoundryPushSettings

Parameters

toolSettings T

stack Stack

Returns

T

Type Parameters

T

SetStartupTimeout<T>(T, int?)

Sets StartupTimeout

Time (in seconds) allowed to elapse between starting up an app and the first healthy response from the app

public static T SetStartupTimeout<T>(this T toolSettings, int? startupTimeout) where T : CloudFoundryPushSettings

Parameters

toolSettings T

startupTimeout int?

Returns

T

Type Parameters

T

SetVariable<T>(T, string, string)

Sets a key-value-pair in Variables

Variable key value pair for variable substitution in manifest

public static T SetVariable<T>(this T toolSettings, string variableKey, string variableValue) where T : CloudFoundryPushSettings

Parameters

toolSettings T

variableKey string

variableValue string

Returns

T

Type Parameters

T

SetVariablesFile<T>(T, string)

Sets VariablesFile

Path to a variable substitution file for manifest; can specify multiple times

public static T SetVariablesFile<T>(this T toolSettings, string variablesFile) where T : CloudFoundryPushSettings

Parameters

toolSettings T

variablesFile string

Returns

T

Type Parameters

T

SetVariables<T>(T, IDictionary<string, string>)

Sets Variables to a new dictionary

Variable key value pair for variable substitution in manifest

public static T SetVariables<T>(this T toolSettings, IDictionary<string, string> variables) where T : CloudFoundryPushSettings

Parameters

toolSettings T

variables IDictionary<string, string>

Returns

T

Type Parameters

T

ToggleIgnoreManifest<T>(T)

Toggles IgnoreManifest

Ignore manifest file

public static T ToggleIgnoreManifest<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ToggleNoRoute<T>(T)

Toggles NoRoute

Do not map a route to this app and remove routes from previous pushes of this app

public static T ToggleNoRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ToggleNoStart<T>(T)

Toggles NoStart

Do not start an app after pushing

public static T ToggleNoStart<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T

ToggleRandomRoute<T>(T)

Toggles RandomRoute

Create a random route for this app

public static T ToggleRandomRoute<T>(this T toolSettings) where T : CloudFoundryPushSettings

Parameters

toolSettings T

Returns

T

Type Parameters

T