File: integrations_v1.projects.locations.integrations.executionsnapshots.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (256 lines) | stat: -rw-r--r-- 11,232 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="integrations_v1.html">Application Integration API</a> . <a href="integrations_v1.projects.html">projects</a> . <a href="integrations_v1.projects.locations.html">locations</a> . <a href="integrations_v1.projects.locations.integrations.html">integrations</a> . <a href="integrations_v1.projects.locations.integrations.executionsnapshots.html">executionsnapshots</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the snapshots of a given integration executions. This RPC is not being used.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code>
  <pre>Lists the snapshots of a given integration executions. This RPC is not being used.

Args:
  parent: string, Required. The parent resource name of the integration execution. (required)
  filter: string, Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
  pageSize: integer, Number of entries to be returned in a page.
  pageToken: string, The token used to retrieve the next page results.
  readMask: string, View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for listing the integration execution snapshot.
  &quot;executionSnapshots&quot;: [ # Required. The detailed information for the execution snapshot.
    { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
      &quot;checkpointTaskNumber&quot;: &quot;A String&quot;, # Indicates &quot;right after which checkpoint task&#x27;s execution&quot; this snapshot is taken.
      &quot;conditionResults&quot;: [ # All of the computed conditions that been calculated.
        { # Contains the combined condition calculation results.
          &quot;currentTaskNumber&quot;: &quot;A String&quot;, # the current task number.
          &quot;nextTaskNumber&quot;: &quot;A String&quot;, # the next task number.
          &quot;result&quot;: True or False, # the result comes out after evaluate the combined condition. True if there&#x27;s no combined condition specified.
        },
      ],
      &quot;diffParams&quot;: { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
        &quot;parameters&quot;: [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
          { # Key-value pair of EventBus parameters.
            &quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
            &quot;value&quot;: { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
              &quot;booleanArray&quot;: {
                &quot;booleanValues&quot;: [
                  True or False,
                ],
              },
              &quot;booleanValue&quot;: True or False,
              &quot;doubleArray&quot;: {
                &quot;doubleValues&quot;: [
                  3.14,
                ],
              },
              &quot;doubleValue&quot;: 3.14,
              &quot;intArray&quot;: {
                &quot;intValues&quot;: [
                  &quot;A String&quot;,
                ],
              },
              &quot;intValue&quot;: &quot;A String&quot;,
              &quot;protoArray&quot;: {
                &quot;protoValues&quot;: [
                  {
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
                  },
                ],
              },
              &quot;protoValue&quot;: {
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
              },
              &quot;serializedObjectValue&quot;: {
                &quot;objectValue&quot;: &quot;A String&quot;,
              },
              &quot;stringArray&quot;: {
                &quot;stringValues&quot;: [
                  &quot;A String&quot;,
                ],
              },
              &quot;stringValue&quot;: &quot;A String&quot;,
            },
          },
        ],
      },
      &quot;eventExecutionInfoId&quot;: &quot;A String&quot;, # Points to the event execution info this snapshot belongs to.
      &quot;eventExecutionSnapshotId&quot;: &quot;A String&quot;, # Auto-generated. Used as primary key for EventExecutionSnapshots table.
      &quot;eventExecutionSnapshotMetadata&quot;: {
        &quot;eventAttemptNum&quot;: 42, # the event attempt number this snapshot belongs to.
        &quot;taskAttemptNum&quot;: 42, # the task attempt number this snapshot belongs to. Could be empty.
        &quot;taskName&quot;: &quot;A String&quot;, # the task name associated with this snapshot. Could be empty.
        &quot;taskNumber&quot;: &quot;A String&quot;, # The task number associated with this snapshot. Could be empty.
      },
      &quot;eventParams&quot;: { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
        &quot;parameters&quot;: [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
          { # Key-value pair of EventBus parameters.
            &quot;key&quot;: &quot;A String&quot;, # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
            &quot;value&quot;: { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
              &quot;booleanArray&quot;: {
                &quot;booleanValues&quot;: [
                  True or False,
                ],
              },
              &quot;booleanValue&quot;: True or False,
              &quot;doubleArray&quot;: {
                &quot;doubleValues&quot;: [
                  3.14,
                ],
              },
              &quot;doubleValue&quot;: 3.14,
              &quot;intArray&quot;: {
                &quot;intValues&quot;: [
                  &quot;A String&quot;,
                ],
              },
              &quot;intValue&quot;: &quot;A String&quot;,
              &quot;protoArray&quot;: {
                &quot;protoValues&quot;: [
                  {
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
                  },
                ],
              },
              &quot;protoValue&quot;: {
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
              },
              &quot;serializedObjectValue&quot;: {
                &quot;objectValue&quot;: &quot;A String&quot;,
              },
              &quot;stringArray&quot;: {
                &quot;stringValues&quot;: [
                  &quot;A String&quot;,
                ],
              },
              &quot;stringValue&quot;: &quot;A String&quot;,
            },
          },
        ],
      },
      &quot;exceedMaxSize&quot;: True or False, # indicate whether snapshot exceeded maximum size before clean up
      &quot;snapshotTime&quot;: &quot;A String&quot;, # Indicates when this snapshot is taken.
      &quot;taskExecutionDetails&quot;: [ # All of the task execution details at the given point of time.
        { # Contains the details of the execution of this task. Next available id: 11
          &quot;taskAttemptStats&quot;: [
            {
              &quot;endTime&quot;: &quot;A String&quot;, # The end time of the task execution for current attempt.
              &quot;startTime&quot;: &quot;A String&quot;, # The start time of the task execution for current attempt. This could be in the future if it&#x27;s been scheduled.
            },
          ],
          &quot;taskExecutionState&quot;: &quot;A String&quot;,
          &quot;taskNumber&quot;: &quot;A String&quot;, # Pointer to the task config it used for execution.
        },
      ],
      &quot;taskName&quot;: &quot;A String&quot;, # The task name associated with this snapshot. Could be empty.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The token returned in the previous response.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>