StageTimeout (jenkins-library 1.4.0 API)

jenkins_shared_library.pipelines.base.models.StageTimeout

Stage timeout information.

Properties Summary

Properties
Type	Name and description
`long`	`time` The amount of time a stage is allowed to execute.
`java.util.concurrent.TimeUnit`	`unit` The unit of measurement for time

Methods Summary

Methods
Type Params	Return Type	Name and description
	`StageTimeout`	`add(StageTimeout value)` Add a timeout to a timeout
	`StageTimeout`	`add(java.util.Map value)` Add using a map of a timeout.
	`StageTimeout`	`subtract(StageTimeout value)` Subtracts a timeout from a timeout
	`StageTimeout`	`subtract(java.util.Map value)` Subtract using a map of a timeout.
	`java.lang.String`	`toString()` Outputs the timeout in the form of "time unit"

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - long time
    
    The amount of time a stage is allowed to execute.
    Default:
    10
  - java.util.concurrent.TimeUnit unit
    
    The unit of measurement for time
    Default:
    java.util.concurrent.TimeUnit#MINUTES
- Method Detail
  - StageTimeout add(StageTimeout value)
    
    Add a timeout to a timeout
    Parameters:
    value - The timeout to add
    Returns:
    A new timeout object representing the operation. The returned value's unit will be that of the input time.
  - StageTimeout add(java.util.Map value)
    
    Add using a map of a timeout.
    Parameters:
    value - The StageTimeout map to construct
    Returns:
    A new timeout object representing the operation
    See Also:
    add(jenkins_shared_library.pipelines.base.models.StageTimeout)
  - StageTimeout subtract(StageTimeout value)
    
    Subtracts a timeout from a timeout
    Parameters:
    value - The timeout to subtract
    Returns:
    A new timeout object representing the operation. The returned value's unit will be that of the input StageTimeout.
  - StageTimeout subtract(java.util.Map value)
    
    Subtract using a map of a timeout.
    Parameters:
    value - The StageTimeout map to construct
    Returns:
    A new timeout object representing the operation
    See Also:
    subtract(jenkins_shared_library.pipelines.base.models.StageTimeout)
  - java.lang.String toString()
    
    Outputs the timeout in the form of "time unit"
    Returns:
    The string representation of this object.

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class StageTimeout

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

long time

java.util.concurrent.TimeUnit unit

Method Detail

StageTimeout add(StageTimeout value)

StageTimeout add(java.util.Map value)

StageTimeout subtract(StageTimeout value)

StageTimeout subtract(java.util.Map value)

java.lang.String toString()