com.google.api.services.toolresults.model

Class ToolExecution

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.ToolExecution

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ToolExecution
extends GenericJson

An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code.

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
ToolExecution()

Method Summary

Modifier and Type	Method and Description
ToolExecution	clone()
List<String>	getCommandLineArguments() The full tokenized command line including the program name (equivalent to argv in a C program).
ToolExitCode	getExitCode() Tool execution exit code.
List<FileReference>	getToolLogs() References to any plain text logs output the tool execution.
List<ToolOutputReference>	getToolOutputs() References to opaque files of any format output by the tool execution.
ToolExecution	set(String fieldName, Object value)
ToolExecution	setCommandLineArguments(List<String> commandLineArguments) The full tokenized command line including the program name (equivalent to argv in a C program).
ToolExecution	setExitCode(ToolExitCode exitCode) Tool execution exit code.
ToolExecution	setToolLogs(List<FileReference> toolLogs) References to any plain text logs output the tool execution.
ToolExecution	setToolOutputs(List<ToolOutputReference> toolOutputs) References to opaque files of any format output by the tool execution.

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

ToolExecution

public ToolExecution()

Method Detail

getCommandLineArguments

public List<String> getCommandLineArguments()

The full tokenized command line including the program name (equivalent to argv in a C program). - In response: present if set by create request - In create request: optional - In update request: never set

Returns:

value or null for none

setCommandLineArguments

public ToolExecution setCommandLineArguments(List<String> commandLineArguments)

The full tokenized command line including the program name (equivalent to argv in a C program). - In response: present if set by create request - In create request: optional - In update request: never set

Parameters:

commandLineArguments - commandLineArguments or null for none

getExitCode

public ToolExitCode getExitCode()

Tool execution exit code. This field will be set once the tool has exited. - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.

Returns:

value or null for none

setExitCode

public ToolExecution setExitCode(ToolExitCode exitCode)

Tool execution exit code. This field will be set once the tool has exited. - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.

Parameters:

exitCode - exitCode or null for none

getToolLogs

public List<FileReference> getToolLogs()

References to any plain text logs output the tool execution. This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running. The maximum allowed number of tool logs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list

Returns:

value or null for none

setToolLogs

public ToolExecution setToolLogs(List<FileReference> toolLogs)

References to any plain text logs output the tool execution. This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running. The maximum allowed number of tool logs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list

Parameters:

toolLogs - toolLogs or null for none

getToolOutputs

public List<ToolOutputReference> getToolOutputs()

References to opaque files of any format output by the tool execution. The maximum allowed number of tool outputs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list

Returns:

value or null for none

setToolOutputs

public ToolExecution setToolOutputs(List<ToolOutputReference> toolOutputs)

References to opaque files of any format output by the tool execution. The maximum allowed number of tool outputs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list

Parameters:

toolOutputs - toolOutputs or null for none

set

public ToolExecution set(String fieldName,
                         Object value)

Overrides:

set in class GenericJson

clone

public ToolExecution clone()

Overrides:

clone in class GenericJson