Class Step

A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.

Inheritance

object

Step

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ToolResults.v1beta3.Data

Assembly: Google.Apis.ToolResults.v1beta3.dll

Syntax

public class Step : IDirectResponseSchema

Properties

CompletionTime

The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set

Declaration

[JsonProperty("completionTime")]
public virtual Timestamp CompletionTime { get; set; }

Property Value

Type	Description
Timestamp

CreationTime

The time when the step was created. - In response: always set - In create/update request: never set

Declaration

[JsonProperty("creationTime")]
public virtual Timestamp CreationTime { get; set; }

Property Value

Type	Description
Timestamp

Description

A description of this tool For example: mvn clean package -D skipTests=true - In response: present if set by create/update request - In create/update request: optional

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DeviceUsageDuration

How much the device resource is used to perform the test. This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage. PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set. - In response: present if previously set. - In create request: optional - In update request: optional

Declaration

[JsonProperty("deviceUsageDuration")]
public virtual Duration DeviceUsageDuration { get; set; }

Property Value

Type	Description
Duration

DimensionValue

If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions. The keys must exactly match the dimension_definition of the execution. For example, if the execution has dimension_definition = ['attempt', 'device'] then a step must define values for those dimensions, eg. dimension_value = ['attempt': '1', 'device': 'Nexus 6'] If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have dimension_value = ['attempt': '', 'device': 'Nexus 6'] If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset. A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution. A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different. A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys. - In response: present if set by create - In create request: optional - In update request: never set

Declaration

[JsonProperty("dimensionValue")]
public virtual IList<StepDimensionValueEntry> DimensionValue { get; set; }

Property Value

Type	Description
IList<StepDimensionValueEntry>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

HasImages

Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails. - In response: always set - In create/update request: never set

Declaration

[JsonProperty("hasImages")]
public virtual bool? HasImages { get; set; }

Property Value

Type	Description
bool?

Labels

Arbitrary user-supplied key/value pairs that are associated with the step. Users are responsible for managing the key namespace such that keys don't accidentally collide. An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters. - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value

Declaration

[JsonProperty("labels")]
public virtual IList<StepLabelsEntry> Labels { get; set; }

Property Value

Type	Description
IList<StepLabelsEntry>

MultiStep

Details when multiple steps are run with the same configuration as a group. These details can be used identify which group this step is part of. It also identifies the groups 'primary step' which indexes all the group members. - In response: present if previously set. - In create request: optional, set iff this step was performed more than once. - In update request: optional

Declaration

[JsonProperty("multiStep")]
public virtual MultiStep MultiStep { get; set; }

Property Value

Type	Description
MultiStep

Name

A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name. - In response: always set - In create request: always set - In update request: never set

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Outcome

Classification of the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional

Declaration

[JsonProperty("outcome")]
public virtual Outcome Outcome { get; set; }

Property Value

Type	Description
Outcome

RunDuration

How long it took for this step to run. If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration. PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set. - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional

Declaration

[JsonProperty("runDuration")]
public virtual Duration RunDuration { get; set; }

Property Value

Type	Description
Duration

State

The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE A PRECONDITION_FAILED will be returned if an invalid transition is requested. It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times. - In response: always set - In create/update request: optional

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

StepId

A unique identifier within a Execution for this Step. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response: always set - In create/update request: never set

Declaration

[JsonProperty("stepId")]
public virtual string StepId { get; set; }

Property Value

Type	Description
string

TestExecutionStep

An execution of a test runner.

Declaration

[JsonProperty("testExecutionStep")]
public virtual TestExecutionStep TestExecutionStep { get; set; }

Property Value

Type	Description
TestExecutionStep

ToolExecutionStep

An execution of a tool (used for steps we don't explicitly support).

Declaration

[JsonProperty("toolExecutionStep")]
public virtual ToolExecutionStep ToolExecutionStep { get; set; }

Property Value

Type	Description
ToolExecutionStep

Implements

IDirectResponseSchema