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

98

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

99

# @OutputOnly

100

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

101

"cpuInfo": { # CPU related environment info

102

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

103

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

104

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

105

},

106

"memoryInfo": { # Memory related environment info

107

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

108

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

109

},

110

},

111

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

112

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

113

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

114

# For more info see:

115

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

116

# Statistics will only be present for API 23+.

117

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

118

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

119

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

120

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

121

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

122

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

123

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

124

{

125

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

126

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

127

},

128

],

129

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

130

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

131

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

132

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

133

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

134

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

135

},

136

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

137

# @OutputOnly

138

"perfMetrics": [ # Set of resource collected

"A String",

],

"appStartTime": {

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

143

# as reported in Logcat. See

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

# to +999,999,999 inclusive.

157

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

158

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

159

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

160

},

161

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

162

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

163

# Activity.reportFullyDrawn(). See

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

# to +999,999,999 inclusive.

177

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

178

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

179

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

180

},

181

},

182

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

183

# @OutputOnly

184

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

# @OutputOnly

}

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

197

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

198

# @OutputOnly

199

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

200

"cpuInfo": { # CPU related environment info

201

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

202

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

203

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

204

},

205

"memoryInfo": { # Memory related environment info

206

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

207

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

208

},

209

},

210

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

211

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

212

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

213

# For more info see:

214

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

215

# Statistics will only be present for API 23+.

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

{

224

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

225

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

226

},

227

],

228

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

229

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

230

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

231

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

232

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

233

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

234

},

235

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

236

# @OutputOnly

237

"perfMetrics": [ # Set of resource collected

"A String",

],

"appStartTime": {

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

242

# as reported in Logcat. See

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

# to +999,999,999 inclusive.

256

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

257

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

258

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

259

},

260

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

261

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

262

# Activity.reportFullyDrawn(). See

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

# to +999,999,999 inclusive.

276

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

277

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

278

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

279

},

280

},

281

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

282

# @OutputOnly

283

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

# @OutputOnly

}</pre>

</div>

</body></html>