com.google.api.services.toolresults

Class ToolResults.Steps

java.lang.Object

com.google.api.services.toolresults.ToolResults.Steps

Enclosing class:

ToolResults

public class ToolResults.Steps
extends Object

The "steps" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ToolResults.Steps.AccessibilityClusters
class	ToolResults.Steps.Create
class	ToolResults.Steps.Get
class	ToolResults.Steps.GetPerfMetricsSummary
class	ToolResults.Steps.List
class	ToolResults.Steps.Patch
class	ToolResults.Steps.PublishXunitXmlFiles

Constructor Summary

Constructors

Constructor and Description
Steps()

Method Summary

Modifier and Type	Method and Description
ToolResults.Steps.AccessibilityClusters	accessibilityClusters(String name) Lists accessibility clusters for a given Step May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g.
ToolResults.Steps.Create	create(String projectId, String historyId, String executionId, Step content) Creates a Step.
ToolResults.Steps.Get	get(String projectId, String historyId, String executionId, String stepId) Gets a Step.
ToolResults.Steps.GetPerfMetricsSummary	getPerfMetricsSummary(String projectId, String historyId, String executionId, String stepId) Retrieves a PerfMetricsSummary.
ToolResults.Steps.List	list(String projectId, String historyId, String executionId) Lists Steps for a given Execution.
ToolResults.Steps.Patch	patch(String projectId, String historyId, String executionId, String stepId, Step content) Updates an existing Step with the supplied partial entity.
ToolResults.Steps.PublishXunitXmlFiles	publishXunitXmlFiles(String projectId, String historyId, String executionId, String stepId, PublishXunitXmlFilesRequest content) Publish xml files to an existing Step.

Methods inherited from class java.lang.Object

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

Constructor Detail

Steps

public Steps()

Method Detail

accessibilityClusters

public ToolResults.Steps.AccessibilityClusters accessibilityClusters(String name)
                                                              throws IOException

Lists accessibility clusters for a given Step May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if the locale format is incorrect - NOT_FOUND - if the containing Step does not exist Create a request for the method "steps.accessibilityClusters". This request holds the parameters needed by the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - A full resource name of the step. For example, projects/my- project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.

Returns:

the request

Throws:

IOException

create

public ToolResults.Steps.Create create(String projectId,
                                       String historyId,
                                       String executionId,
                                       Step content)
                                throws IOException

Creates a Step. The returned Step will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist Create a request for the method "steps.create". This request holds the parameters needed by the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

projectId - Required. A Project id.

historyId - Required. A History id.

executionId - Required. An Execution id.

content - the Step

Returns:

the request

Throws:

IOException

get

public ToolResults.Steps.Get get(String projectId,
                                 String historyId,
                                 String executionId,
                                 String stepId)
                          throws IOException

Gets a Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist Create a request for the method "steps.get". This request holds the parameters needed by the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

projectId - A Project id. Required.

historyId - A History id. Required.

executionId - A Execution id. Required.

stepId - A Step id. Required.

Returns:

the request

Throws:

IOException

getPerfMetricsSummary

public ToolResults.Steps.GetPerfMetricsSummary getPerfMetricsSummary(String projectId,
                                                                     String historyId,
                                                                     String executionId,
                                                                     String stepId)
                                                              throws IOException

Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist Create a request for the method "steps.getPerfMetricsSummary". This request holds the parameters needed by the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

projectId - The cloud project

historyId - A tool results history ID.

executionId - A tool results execution ID.

stepId - A tool results step ID.

Returns:

the request

Throws:

IOException

list

public ToolResults.Steps.List list(String projectId,
                                   String historyId,
                                   String executionId)
                            throws IOException

Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist Create a request for the method "steps.list". This request holds the parameters needed by the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

projectId - A Project id. Required.

historyId - A History id. Required.

executionId - A Execution id. Required.

Returns:

the request

Throws:

IOException

patch

public ToolResults.Steps.Patch patch(String projectId,
                                     String historyId,
                                     String executionId,
                                     String stepId,
                                     Step content)
                              throws IOException

Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist Create a request for the method "steps.patch". This request holds the parameters needed by the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

projectId - A Project id. Required.

historyId - A History id. Required.

executionId - A Execution id. Required.

stepId - A Step id. Required.

content - the Step

Returns:

the request

Throws:

IOException

publishXunitXmlFiles

public ToolResults.Steps.PublishXunitXmlFiles publishXunitXmlFiles(String projectId,
                                                                   String historyId,
                                                                   String executionId,
                                                                   String stepId,
                                                                   PublishXunitXmlFilesRequest content)
                                                            throws IOException

Publish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist Create a request for the method "steps.publishXunitXmlFiles". This request holds the parameters needed by the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

projectId - A Project id. Required.

historyId - A History id. Required.

executionId - A Execution id. Required.

stepId - A Step id. Note: This step must include a TestExecutionStep. Required.

content - the PublishXunitXmlFilesRequest

Returns:

the request

Throws:

IOException