1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\WorkflowExecutions\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\WorkflowExecutions\ListStepEntriesResponse;
|
---|
21 | use Google\Service\WorkflowExecutions\StepEntry;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "stepEntries" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $workflowexecutionsService = new Google\Service\WorkflowExecutions(...);
|
---|
28 | * $stepEntries = $workflowexecutionsService->projects_locations_workflows_executions_stepEntries;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class ProjectsLocationsWorkflowsExecutionsStepEntries extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Gets a step entry. (stepEntries.get)
|
---|
35 | *
|
---|
36 | * @param string $name Required. The name of the step entry to retrieve. Format:
|
---|
37 | * projects/{project}/locations/{location}/workflows/{workflow}/executions/{exec
|
---|
38 | * ution}/stepEntries/{step_entry}
|
---|
39 | * @param array $optParams Optional parameters.
|
---|
40 | *
|
---|
41 | * @opt_param string view Deprecated field.
|
---|
42 | * @return StepEntry
|
---|
43 | * @throws \Google\Service\Exception
|
---|
44 | */
|
---|
45 | public function get($name, $optParams = [])
|
---|
46 | {
|
---|
47 | $params = ['name' => $name];
|
---|
48 | $params = array_merge($params, $optParams);
|
---|
49 | return $this->call('get', [$params], StepEntry::class);
|
---|
50 | }
|
---|
51 | /**
|
---|
52 | * Lists step entries for the corresponding workflow execution. Returned entries
|
---|
53 | * are ordered by their create_time.
|
---|
54 | * (stepEntries.listProjectsLocationsWorkflowsExecutionsStepEntries)
|
---|
55 | *
|
---|
56 | * @param string $parent Required. Name of the workflow execution to list
|
---|
57 | * entries for. Format: projects/{project}/locations/{location}/workflows/{workf
|
---|
58 | * low}/executions/{execution}
|
---|
59 | * @param array $optParams Optional parameters.
|
---|
60 | *
|
---|
61 | * @opt_param string filter Optional. Filters applied to the
|
---|
62 | * `[StepEntries.ListStepEntries]` results. The following fields are supported
|
---|
63 | * for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`,
|
---|
64 | * `stepType`, `parent`, `state`. For details, see AIP-160. For example, if you
|
---|
65 | * are using the Google APIs Explorer: `state="SUCCEEDED"` or
|
---|
66 | * `createTime>"2023-08-01" AND state="FAILED"`
|
---|
67 | * @opt_param string orderBy Optional. Comma-separated list of fields that
|
---|
68 | * specify the ordering applied to the `[StepEntries.ListStepEntries]` results.
|
---|
69 | * By default the ordering is based on ascending `entryId`. The following fields
|
---|
70 | * are supported for ordering: `entryId`, `createTime`, `updateTime`, `routine`,
|
---|
71 | * `step`, `stepType`, `state`. For details, see AIP-132.
|
---|
72 | * @opt_param int pageSize Optional. Number of step entries to return per call.
|
---|
73 | * The default max is 1000.
|
---|
74 | * @opt_param string pageToken Optional. A page token, received from a previous
|
---|
75 | * `ListStepEntries` call. Provide this to retrieve the subsequent page. When
|
---|
76 | * paginating, all other parameters provided to `ListStepEntries` must match the
|
---|
77 | * call that provided the page token.
|
---|
78 | * @opt_param int skip Optional. The number of step entries to skip. It can be
|
---|
79 | * used with or without a pageToken. If used with a pageToken, then it indicates
|
---|
80 | * the number of step entries to skip starting from the requested page.
|
---|
81 | * @opt_param string view Deprecated field.
|
---|
82 | * @return ListStepEntriesResponse
|
---|
83 | * @throws \Google\Service\Exception
|
---|
84 | */
|
---|
85 | public function listProjectsLocationsWorkflowsExecutionsStepEntries($parent, $optParams = [])
|
---|
86 | {
|
---|
87 | $params = ['parent' => $parent];
|
---|
88 | $params = array_merge($params, $optParams);
|
---|
89 | return $this->call('list', [$params], ListStepEntriesResponse::class);
|
---|
90 | }
|
---|
91 | }
|
---|
92 |
|
---|
93 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
94 | class_alias(ProjectsLocationsWorkflowsExecutionsStepEntries::class, 'Google_Service_WorkflowExecutions_Resource_ProjectsLocationsWorkflowsExecutionsStepEntries');
|
---|