com.openshift.internal.restclient.capability.resources

Class DeploymentTrigger

java.lang.Object

com.openshift.internal.restclient.capability.AbstractCapability

com.openshift.internal.restclient.capability.resources.DeploymentTrigger

All Implemented Interfaces:

ICapability, IDeploymentTriggerable

public class DeploymentTrigger
extends AbstractCapability
implements IDeploymentTriggerable

Author:

Gabe Montero

Constructor Summary

Constructors

Constructor and Description
DeploymentTrigger(IDeploymentConfig resource, IClient client, ITypeFactory factory)

Method Summary

Modifier and Type	Method and Description
String	getName() Well known name of the capability
String	getResourceName() Returns the name of the deployment config seeded into the deployment request
boolean	isForce() Returns the latest setting of the force flag.
boolean	isLatest() Returns the current setting of the latest flag.
boolean	isSupported() Allow the implementation of the capability to determine if it is supported on the OpenShift server.
void	setForce(boolean force) If set to try force will try to force a new deployment to run.
void	setLatest(boolean latest) If set the true latest will update the deployment config with the latest state from all triggers.
void	setResourceName(String name) The name of the deployment config; note, the name in the corresponding oapi type is not in the k8s metadata object
IDeploymentConfig	trigger() Trigger a deployment based on a deployment config

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeploymentTrigger

public DeploymentTrigger(IDeploymentConfig resource,
                         IClient client,
                         ITypeFactory factory)

Method Detail

getName

public String getName()

Description copied from interface: ICapability

Well known name of the capability

Specified by:

getName in interface ICapability

isSupported

public boolean isSupported()

Description copied from interface: ICapability

Allow the implementation of the capability to determine if it is supported on the OpenShift server. Implementations should return false if they can not

Specified by:

isSupported in interface ICapability

Overrides:

isSupported in class AbstractCapability

Returns:

true if the capability exists

trigger

public IDeploymentConfig trigger()

Description copied from interface: IDeploymentTriggerable

Trigger a deployment based on a deployment config

Specified by:

trigger in interface IDeploymentTriggerable

Returns:

The updated deployment config after the deployment was triggered

setLatest

public void setLatest(boolean latest)

Description copied from interface: IDeploymentTriggerable

If set the true latest will update the deployment config with the latest state from all triggers.

Specified by:

setLatest in interface IDeploymentTriggerable

isLatest

public boolean isLatest()

Description copied from interface: IDeploymentTriggerable

Returns the current setting of the latest flag.

Specified by:

isLatest in interface IDeploymentTriggerable

setForce

public void setForce(boolean force)

Description copied from interface: IDeploymentTriggerable

If set to try force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error.

Specified by:

setForce in interface IDeploymentTriggerable

isForce

public boolean isForce()

Description copied from interface: IDeploymentTriggerable

Returns the latest setting of the force flag.

Specified by:

isForce in interface IDeploymentTriggerable

setResourceName

public void setResourceName(String name)

Description copied from interface: IDeploymentTriggerable

The name of the deployment config; note, the name in the corresponding oapi type is not in the k8s metadata object

Specified by:

setResourceName in interface IDeploymentTriggerable

Parameters:

name - of the deployment config

getResourceName

public String getResourceName()

Description copied from interface: IDeploymentTriggerable

Returns the name of the deployment config seeded into the deployment request

Specified by:

getResourceName in interface IDeploymentTriggerable