Blame - docs/dyn/toolresults_v1beta3.perfMetricsSummary.html - platform/external/python/google-api-python-client

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

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="toolresults_v1beta3.html">Cloud Tool Results API</a> . <a href="toolresults_v1beta3.perfMetricsSummary.html">perfMetricsSummary</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#create">create(projectId, historyId, executionId, stepId, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Creates a PerfMetricsSummary resource. Returns the existing one if it has</p>

80

<h3>Method Details</h3>

81

82

<code class="details" id="create">create(projectId, historyId, executionId, stepId, body=None, x__xgafv=None)</code>

83

<pre>Creates a PerfMetricsSummary resource. Returns the existing one if it has

84

already been created.

85

86

May return any of the following error code(s):

87

- NOT_FOUND - The containing Step does not exist

88

89

Args:

90

projectId: string, The cloud project (required)

91

historyId: string, A tool results history ID. (required)

92

executionId: string, A tool results execution ID. (required)

93

stepId: string, A tool results step ID. (required)

94

body: object, The request body.

95

The object takes the form of:

96

97

{ # A summary of perf metrics collected and performance environment info

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

98

"stepId": "A String", # A tool results step ID.

99

# @OutputOnly

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

100

"historyId": "A String", # A tool results history ID.

101

# @OutputOnly

102

"perfEnvironment": { # Encapsulates performance environment info # Describes the environment in which the performance metrics were collected

103

"cpuInfo": { # CPU related environment info

104

"numberOfCores": 42, # the number of CPU cores

105

"cpuProcessor": "A String", # description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A'

106

"cpuSpeedInGhz": 3.14, # the CPU clock speed in GHz

107

},

108

"memoryInfo": { # Memory related environment info

109

"memoryTotalInKibibyte": "A String", # Total memory available on the device in KiB

110

"memoryCapInKibibyte": "A String", # Maximum memory that can be allocated to the process in KiB

111

},

112

},

113

"graphicsStats": { # Graphics statistics for the App. # Graphics statistics for the entire run. Statistics are reset at the

114

# beginning of the run and collected at the end of the run.

115

# The information is collected from 'adb shell dumpsys graphicsstats'.

116

# For more info see:

117

# https://developer.android.com/training/testing/performance.html

118

# Statistics will only be present for API 23+.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

119

"slowBitmapUploadCount": "A String", # Total "slow bitmap upload" events.

120

"buckets": [ # Histogram of frame render times. There should be 154 buckets ranging from

121

# [5ms, 6ms) to [4950ms, infinity)

122

{

123

"frameCount": "A String", # Number of frames in the bucket.

124

"renderMillis": "A String", # Lower bound of render time in milliseconds.

125

},

126

],

127

"totalFrames": "A String", # Total frames rendered by package.

128

"p50Millis": "A String", # 50th percentile frame render time in milliseconds.

129

"slowUiThreadCount": "A String", # Total "slow UI thread" events.

130

"p99Millis": "A String", # 99th percentile frame render time in milliseconds.

131

"slowDrawCount": "A String", # Total "slow draw" events.

132

"highInputLatencyCount": "A String", # Total "high input latency" events.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

133

"p95Millis": "A String", # 95th percentile frame render time in milliseconds.

134

"missedVsyncCount": "A String", # Total "missed vsync" events.

135

"p90Millis": "A String", # 90th percentile frame render time in milliseconds.

136

"jankyFrames": "A String", # Total frames with slow render time. Should be <= total_frames.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

137

},

138

"projectId": "A String", # The cloud project

139

# @OutputOnly

140

"perfMetrics": [ # Set of resource collected

"A String",

],

"appStartTime": {

"initialDisplayTime": { # # The time from app start to the first displayed activity being drawn,

145

# as reported in Logcat. See

146

# https://developer.android.com/topic/performance/launch-time.html#time-initial

147

# A Duration represents a signed, fixed-length span of time represented

148

# as a count of seconds and fractions of seconds at nanosecond

149

# resolution. It is independent of any calendar and concepts like "day"

150

# or "month". It is related to Timestamp in that the difference between

151

# two Timestamp values is a Duration and it can be added or subtracted

152

# from a Timestamp. Range is approximately +-10,000 years.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

153

"seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000

154

# to +315,576,000,000 inclusive. Note: these bounds are computed from:

155

# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

156

"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span

157

# of time. Durations less than one second are represented with a 0

158

# `seconds` field and a positive or negative `nanos` field. For durations

159

# of one second or more, a non-zero value for the `nanos` field must be

160

# of the same sign as the `seconds` field. Must be from -999,999,999

161

# to +999,999,999 inclusive.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

162

},

163

"fullyDrawnTime": { # # Optional. The time from app start to reaching the developer-reported

164

# "fully drawn" time. This is only stored if the app includes a call to

165

# Activity.reportFullyDrawn(). See

166

# https://developer.android.com/topic/performance/launch-time.html#time-full

167

# A Duration represents a signed, fixed-length span of time represented

168

# as a count of seconds and fractions of seconds at nanosecond

169

# resolution. It is independent of any calendar and concepts like "day"

170

# or "month". It is related to Timestamp in that the difference between

171

# two Timestamp values is a Duration and it can be added or subtracted

172

# from a Timestamp. Range is approximately +-10,000 years.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

173

"seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000

174

# to +315,576,000,000 inclusive. Note: these bounds are computed from:

175

# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span

177

# of time. Durations less than one second are represented with a 0

178

# `seconds` field and a positive or negative `nanos` field. For durations

179

# of one second or more, a non-zero value for the `nanos` field must be

180

# of the same sign as the `seconds` field. Must be from -999,999,999

181

# to +999,999,999 inclusive.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

182

},

183

},

184

"executionId": "A String", # A tool results execution ID.

185

# @OutputOnly

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

186

}

187

188

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

195

196

{ # A summary of perf metrics collected and performance environment info

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

197

"stepId": "A String", # A tool results step ID.

198

# @OutputOnly

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

199

"historyId": "A String", # A tool results history ID.

200

# @OutputOnly

201

"perfEnvironment": { # Encapsulates performance environment info # Describes the environment in which the performance metrics were collected

202

"cpuInfo": { # CPU related environment info

203

"numberOfCores": 42, # the number of CPU cores

204

"cpuProcessor": "A String", # description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A'

205

"cpuSpeedInGhz": 3.14, # the CPU clock speed in GHz

206

},

207

"memoryInfo": { # Memory related environment info

208

"memoryTotalInKibibyte": "A String", # Total memory available on the device in KiB

209

"memoryCapInKibibyte": "A String", # Maximum memory that can be allocated to the process in KiB

210

},

211

},

212

"graphicsStats": { # Graphics statistics for the App. # Graphics statistics for the entire run. Statistics are reset at the

213

# beginning of the run and collected at the end of the run.

214

# The information is collected from 'adb shell dumpsys graphicsstats'.

215

# For more info see:

216

# https://developer.android.com/training/testing/performance.html

217

# Statistics will only be present for API 23+.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

218

"slowBitmapUploadCount": "A String", # Total "slow bitmap upload" events.

219

"buckets": [ # Histogram of frame render times. There should be 154 buckets ranging from

220

# [5ms, 6ms) to [4950ms, infinity)

221

{

222

"frameCount": "A String", # Number of frames in the bucket.

223

"renderMillis": "A String", # Lower bound of render time in milliseconds.

224

},

225

],

226

"totalFrames": "A String", # Total frames rendered by package.

227

"p50Millis": "A String", # 50th percentile frame render time in milliseconds.

228

"slowUiThreadCount": "A String", # Total "slow UI thread" events.

229

"p99Millis": "A String", # 99th percentile frame render time in milliseconds.

230

"slowDrawCount": "A String", # Total "slow draw" events.

231

"highInputLatencyCount": "A String", # Total "high input latency" events.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

232

"p95Millis": "A String", # 95th percentile frame render time in milliseconds.

233

"missedVsyncCount": "A String", # Total "missed vsync" events.

234

"p90Millis": "A String", # 90th percentile frame render time in milliseconds.

235

"jankyFrames": "A String", # Total frames with slow render time. Should be <= total_frames.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

236

},

237

"projectId": "A String", # The cloud project

238

# @OutputOnly

239

"perfMetrics": [ # Set of resource collected

"A String",

],

"appStartTime": {

"initialDisplayTime": { # # The time from app start to the first displayed activity being drawn,

244

# as reported in Logcat. See

245

# https://developer.android.com/topic/performance/launch-time.html#time-initial

246

# A Duration represents a signed, fixed-length span of time represented

247

# as a count of seconds and fractions of seconds at nanosecond

248

# resolution. It is independent of any calendar and concepts like "day"

249

# or "month". It is related to Timestamp in that the difference between

250

# two Timestamp values is a Duration and it can be added or subtracted

251

# from a Timestamp. Range is approximately +-10,000 years.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

252

"seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000

253

# to +315,576,000,000 inclusive. Note: these bounds are computed from:

254

# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

255

"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span

256

# of time. Durations less than one second are represented with a 0

257

# `seconds` field and a positive or negative `nanos` field. For durations

258

# of one second or more, a non-zero value for the `nanos` field must be

259

# of the same sign as the `seconds` field. Must be from -999,999,999

260

# to +999,999,999 inclusive.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

261

},

262

"fullyDrawnTime": { # # Optional. The time from app start to reaching the developer-reported

263

# "fully drawn" time. This is only stored if the app includes a call to

264

# Activity.reportFullyDrawn(). See

265

# https://developer.android.com/topic/performance/launch-time.html#time-full

266

# A Duration represents a signed, fixed-length span of time represented

267

# as a count of seconds and fractions of seconds at nanosecond

268

# resolution. It is independent of any calendar and concepts like "day"

269

# or "month". It is related to Timestamp in that the difference between

270

# two Timestamp values is a Duration and it can be added or subtracted

271

# from a Timestamp. Range is approximately +-10,000 years.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

272

"seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000

273

# to +315,576,000,000 inclusive. Note: these bounds are computed from:

274

# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

275

"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span

276

# of time. Durations less than one second are represented with a 0

277

# `seconds` field and a positive or negative `nanos` field. For durations

278

# of one second or more, a non-zero value for the `nanos` field must be

279

# of the same sign as the `seconds` field. Must be from -999,999,999

280

# to +999,999,999 inclusive.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

281

},

282

},

283

"executionId": "A String", # A tool results execution ID.

284

# @OutputOnly

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

</body></html>