target.apidocs.com.google.api.services.toolresults.model.Step.html Maven / Gradle / Ivy

Go to download







Step (Cloud Tool Results API v1beta3-rev20210809-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.toolresults.model
Class Step



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.toolresults.model.Step













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Step
extends GenericJson
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 an 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. Next tag: 27

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Cloud Tool Results API. For a detailed explanation
 see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Step() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Step
clone() 


Timestamp
getCompletionTime()
The time when the step status was set to complete.



Timestamp
getCreationTime()
The time when the step was created.



String
getDescription()
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



Duration
getDeviceUsageDuration()
How much the device resource is used to perform the test.



List<StepDimensionValueEntry>
getDimensionValue()
If the execution containing this step has any dimension_definition set, then this field allows
 the child to specify the values of the dimensions.



Boolean
getHasImages()
Whether any of the outputs of this step are images whose thumbnails can be fetched with
 ListThumbnails.



List<StepLabelsEntry>
getLabels()
Arbitrary user-supplied key/value pairs that are associated with the step.



MultiStep
getMultiStep()
Details when multiple steps are run with the same configuration as a group.



String
getName()
A short human-readable name to display in the UI.



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



Duration
getRunDuration()
How long it took for this step to run.



String
getState()
The initial state is IN_PROGRESS.



String
getStepId()
A unique identifier within a Execution for this Step.



TestExecutionStep
getTestExecutionStep()
An execution of a test runner.



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



Step
set(String fieldName,
   Object value) 


Step
setCompletionTime(Timestamp completionTime)
The time when the step status was set to complete.



Step
setCreationTime(Timestamp creationTime)
The time when the step was created.



Step
setDescription(String 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



Step
setDeviceUsageDuration(Duration deviceUsageDuration)
How much the device resource is used to perform the test.



Step
setDimensionValue(List<StepDimensionValueEntry> 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.



Step
setHasImages(Boolean hasImages)
Whether any of the outputs of this step are images whose thumbnails can be fetched with
 ListThumbnails.



Step
setLabels(List<StepLabelsEntry> labels)
Arbitrary user-supplied key/value pairs that are associated with the step.



Step
setMultiStep(MultiStep multiStep)
Details when multiple steps are run with the same configuration as a group.



Step
setName(String name)
A short human-readable name to display in the UI.



Step
setOutcome(Outcome 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



Step
setRunDuration(Duration runDuration)
How long it took for this step to run.



Step
setState(String state)
The initial state is IN_PROGRESS.



Step
setStepId(String stepId)
A unique identifier within a Execution for this Step.



Step
setTestExecutionStep(TestExecutionStep testExecutionStep)
An execution of a test runner.



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







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Step
public Step()









Method Detail





getCompletionTime
public Timestamp getCompletionTime()
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

Returns:
value or null for none








setCompletionTime
public Step setCompletionTime(Timestamp 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

Parameters:
completionTime - completionTime or null for none








getCreationTime
public Timestamp getCreationTime()
The time when the step was created. - In response: always set - In create/update request: never
 set

Returns:
value or null for none








setCreationTime
public Step setCreationTime(Timestamp creationTime)
The time when the step was created. - In response: always set - In create/update request: never
 set

Parameters:
creationTime - creationTime or null for none








getDescription
public String getDescription()
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

Returns:
value or null for none








setDescription
public Step setDescription(String 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

Parameters:
description - description or null for none








getDeviceUsageDuration
public Duration getDeviceUsageDuration()
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

Returns:
value or null for none








setDeviceUsageDuration
public Step setDeviceUsageDuration(Duration 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

Parameters:
deviceUsageDuration - deviceUsageDuration or null for none








getDimensionValue
public List<StepDimensionValueEntry> getDimensionValue()
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

Returns:
value or null for none








setDimensionValue
public Step setDimensionValue(List<StepDimensionValueEntry> 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

Parameters:
dimensionValue - dimensionValue or null for none








getHasImages
public Boolean getHasImages()
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

Returns:
value or null for none








setHasImages
public Step setHasImages(Boolean 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

Parameters:
hasImages - hasImages or null for none








getLabels
public List<StepLabelsEntry> getLabels()
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

Returns:
value or null for none








setLabels
public Step setLabels(List<StepLabelsEntry> 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

Parameters:
labels - labels or null for none








getMultiStep
public MultiStep getMultiStep()
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

Returns:
value or null for none








setMultiStep
public Step setMultiStep(MultiStep 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

Parameters:
multiStep - multiStep or null for none








getName
public String getName()
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

Returns:
value or null for none








setName
public Step setName(String 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

Parameters:
name - name or null for none








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

Returns:
value or null for none








setOutcome
public Step setOutcome(Outcome 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

Parameters:
outcome - outcome or null for none








getRunDuration
public Duration getRunDuration()
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

Returns:
value or null for none








setRunDuration
public Step setRunDuration(Duration 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

Parameters:
runDuration - runDuration or null for none








getState
public String getState()
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

Returns:
value or null for none








setState
public Step setState(String 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

Parameters:
state - state or null for none








getStepId
public String getStepId()
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

Returns:
value or null for none








setStepId
public Step setStepId(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

Parameters:
stepId - stepId or null for none








getTestExecutionStep
public TestExecutionStep getTestExecutionStep()
An execution of a test runner.

Returns:
value or null for none








setTestExecutionStep
public Step setTestExecutionStep(TestExecutionStep testExecutionStep)
An execution of a test runner.

Parameters:
testExecutionStep - testExecutionStep or null for none








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

Returns:
value or null for none








setToolExecutionStep
public Step setToolExecutionStep(ToolExecutionStep toolExecutionStep)
An execution of a tool (used for steps we don't explicitly support).

Parameters:
toolExecutionStep - toolExecutionStep or null for none








set
public Step set(String fieldName,
                Object value)

Overrides:
set in class GenericJson








clone
public Step clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`Step`	`clone()`
`Timestamp`	`getCompletionTime()` The time when the step status was set to complete.
`Timestamp`	`getCreationTime()` The time when the step was created.
`String`	`getDescription()` 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
`Duration`	`getDeviceUsageDuration()` How much the device resource is used to perform the test.
`List<StepDimensionValueEntry>`	`getDimensionValue()` If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
`Boolean`	`getHasImages()` Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
`List<StepLabelsEntry>`	`getLabels()` Arbitrary user-supplied key/value pairs that are associated with the step.
`MultiStep`	`getMultiStep()` Details when multiple steps are run with the same configuration as a group.
`String`	`getName()` A short human-readable name to display in the UI.
`Outcome`	`getOutcome()` Classification of the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional
`Duration`	`getRunDuration()` How long it took for this step to run.
`String`	`getState()` The initial state is IN_PROGRESS.
`String`	`getStepId()` A unique identifier within a Execution for this Step.
`TestExecutionStep`	`getTestExecutionStep()` An execution of a test runner.
`ToolExecutionStep`	`getToolExecutionStep()` An execution of a tool (used for steps we don't explicitly support).
`Step`	`set(String fieldName, Object value)`
`Step`	`setCompletionTime(Timestamp completionTime)` The time when the step status was set to complete.
`Step`	`setCreationTime(Timestamp creationTime)` The time when the step was created.
`Step`	`setDescription(String 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
`Step`	`setDeviceUsageDuration(Duration deviceUsageDuration)` How much the device resource is used to perform the test.
`Step`	`setDimensionValue(List<StepDimensionValueEntry> 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.
`Step`	`setHasImages(Boolean hasImages)` Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
`Step`	`setLabels(List<StepLabelsEntry> labels)` Arbitrary user-supplied key/value pairs that are associated with the step.
`Step`	`setMultiStep(MultiStep multiStep)` Details when multiple steps are run with the same configuration as a group.
`Step`	`setName(String name)` A short human-readable name to display in the UI.
`Step`	`setOutcome(Outcome 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
`Step`	`setRunDuration(Duration runDuration)` How long it took for this step to run.
`Step`	`setState(String state)` The initial state is IN_PROGRESS.
`Step`	`setStepId(String stepId)` A unique identifier within a Execution for this Step.
`Step`	`setTestExecutionStep(TestExecutionStep testExecutionStep)` An execution of a test runner.
`Step`	`setToolExecutionStep(ToolExecutionStep toolExecutionStep)` An execution of a tool (used for steps we don't explicitly support).