Blame - docs/dyn/firebaseml_v1beta2.projects.models.html - platform/external/python/google-api-python-client

2020-07-22 17:02:09 -0700

[diff] [blame]

87

<code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Lists the models</p>

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

93

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Updates a model. The longrunning operation will eventually return a Model.</p>

95

<h3>Method Details</h3>

96

97

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

98

<pre>Creates a model in Firebase ML.

99

The longrunning operation will eventually return a Model

100

101

Args:

102

parent: string, Required. The parent project resource where the model is to be created.

103

The parent must have the form `projects/{project_id}` (required)

104

body: object, The request body.

105

The object takes the form of:

106

107

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

108

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

109

{ # This resource represents a long-running operation that is the result of a

110

# network API call.

111

"done": True or False, # If the value is `false`, it means the operation is still in progress.

112

# If `true`, the operation is completed, and either `error` or `response` is

113

# available.

114

"name": "A String", # The server-assigned name, which is only unique within the same service that

115

# originally returns it. If you use the default HTTP mapping, the

116

# `name` should be a resource name ending with `operations/{unique_id}`.

117

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

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

[diff] [blame]

118

# different programming environments, including REST APIs and RPC APIs. It is

119

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

120

# three pieces of data: error code, error message, and error details.

121

#

122

# You can find out more about this error model and how to work with it in the

123

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

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

[diff] [blame]

124

"message": "A String", # A developer-facing error message, which should be in English. Any

125

# user-facing error message should be localized and sent in the

126

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

127

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

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

[diff] [blame]

128

"details": [ # A list of messages that carry the error details. There is a common set of

129

# message types for APIs to use.

130

{

131

"a_key": "", # Properties of the object. Contains field @type with type URL.

132

},

133

],

134

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

135

"response": { # The normal response of the operation in case of success. If the original

136

# method returns no data on success, such as `Delete`, the response is

137

# `google.protobuf.Empty`. If the original method is standard

138

# `Get`/`Create`/`Update`, the response should be the resource. For other

139

# methods, the response should have the type `XxxResponse`, where `Xxx`

140

# is the original method name. For example, if the original method name

141

# is `TakeSnapshot()`, the inferred response type is

142

# `TakeSnapshotResponse`.

143

"a_key": "", # Properties of the object. Contains field @type with type URL.

144

},

145

"metadata": { # Service-specific metadata associated with the operation. It typically

146

# contains progress information and common metadata such as create time.

147

# Some services might not provide such metadata. Any method that returns a

148

# long-running operation should document the metadata type, if any.

149

"a_key": "", # Properties of the object. Contains field @type with type URL.

150

},

Bu Sun Kim

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

[diff] [blame]

151

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

152

],

153

"tags": [ # User defined tags which can be used to group/filter models during listing

154

"A String",

155

],

156

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

157

"sizeBytes": "A String", # Output only. The size of the TFLite model

158

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).

159

# The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite

160

# Note: If you update the file in the original location, it is

161

# necessary to call UpdateModel for ML to pick up and validate the

162

# updated file.

163

},

164

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long

165

# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)

166

# and ASCII digits 0-9. It must start with a letter.

167

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

168

"name": "A String", # The resource name of the Model.

169

# Model names have the form `projects/{project_id}/models/{model_id}`

170

# The name is ignored when creating a model.

171

"state": { # State common to all model types. # State common to all model types.

172

# Includes publishing and validation information.

173

# Includes publishing and validation information.

174

"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.

175

# A model may have validation errors if there were problems during

176

# the model creation/update.

177

# e.g. in the case of a TfLiteModel, if a tflite model file was

178

# missing or in the wrong format.

179

# This field will be empty for valid models.

180

# different programming environments, including REST APIs and RPC APIs. It is

181

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

182

# three pieces of data: error code, error message, and error details.

183

#

184

# You can find out more about this error model and how to work with it in the

185

# [API Design Guide](https://cloud.google.com/apis/design/errors).

186

"message": "A String", # A developer-facing error message, which should be in English. Any

187

# user-facing error message should be localized and sent in the

188

# google.rpc.Status.details field, or localized by the client.

189

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

190

"details": [ # A list of messages that carry the error details. There is a common set of

191

# message types for APIs to use.

192

{

193

"a_key": "", # Properties of the object. Contains field @type with type URL.

194

},

195

],

Bu Sun Kim

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

[diff] [blame]

196

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

197

"published": True or False, # Indicates if this model has been published.

198

},

199

"etag": "A String", # Output only. See RFC7232

200

# https://tools.ietf.org/html/rfc7232#section-2.3

201

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

202

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

203

}

Bu Sun Kim

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

[diff] [blame]

204

205

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

212

213

{ # This resource represents a long-running operation that is the result of a

214

# network API call.

Bu Sun Kim

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

[diff] [blame]

215

"done": True or False, # If the value is `false`, it means the operation is still in progress.

216

# If `true`, the operation is completed, and either `error` or `response` is

217

# available.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

218

"name": "A String", # The server-assigned name, which is only unique within the same service that

219

# originally returns it. If you use the default HTTP mapping, the

220

# `name` should be a resource name ending with `operations/{unique_id}`.

221

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

222

# different programming environments, including REST APIs and RPC APIs. It is

223

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

224

# three pieces of data: error code, error message, and error details.

225

#

226

# You can find out more about this error model and how to work with it in the

227

# [API Design Guide](https://cloud.google.com/apis/design/errors).

228

"message": "A String", # A developer-facing error message, which should be in English. Any

229

# user-facing error message should be localized and sent in the

230

# google.rpc.Status.details field, or localized by the client.

231

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

232

"details": [ # A list of messages that carry the error details. There is a common set of

233

# message types for APIs to use.

234

{

235

"a_key": "", # Properties of the object. Contains field @type with type URL.

236

},

237

],

238

},

Bu Sun Kim

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

[diff] [blame]

239

"response": { # The normal response of the operation in case of success. If the original

240

# method returns no data on success, such as `Delete`, the response is

241

# `google.protobuf.Empty`. If the original method is standard

242

# `Get`/`Create`/`Update`, the response should be the resource. For other

243

# methods, the response should have the type `XxxResponse`, where `Xxx`

244

# is the original method name. For example, if the original method name

245

# is `TakeSnapshot()`, the inferred response type is

246

# `TakeSnapshotResponse`.

247

"a_key": "", # Properties of the object. Contains field @type with type URL.

248

},

Bu Sun Kim

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

[diff] [blame]

249

"metadata": { # Service-specific metadata associated with the operation. It typically

250

# contains progress information and common metadata such as create time.

251

# Some services might not provide such metadata. Any method that returns a

252

# long-running operation should document the metadata type, if any.

253

"a_key": "", # Properties of the object. Contains field @type with type URL.

254

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

<pre>Deletes a model

Args:

The name must have the form `projects/{project_id}/models/{model_id}` (required)

265

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

272

273

{ # A generic empty message that you can re-use to avoid defining duplicated

274

# empty messages in your APIs. A typical example is to use it as the request

275

# or the response type of an API method. For instance:

276

#

277

# service Foo {

278

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

279

# }

280

#

281

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

287

<pre>Gets a model resource.

Args:

The name must have the form `projects/{project_id}/models/{model_id}` (required)

292

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

299

300

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

301

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

302

{ # This resource represents a long-running operation that is the result of a

303

# network API call.

304

"done": True or False, # If the value is `false`, it means the operation is still in progress.

305

# If `true`, the operation is completed, and either `error` or `response` is

306

# available.

307

"name": "A String", # The server-assigned name, which is only unique within the same service that

308

# originally returns it. If you use the default HTTP mapping, the

309

# `name` should be a resource name ending with `operations/{unique_id}`.

310

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

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

[diff] [blame]

311

# different programming environments, including REST APIs and RPC APIs. It is

312

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

313

# three pieces of data: error code, error message, and error details.

314

#

315

# You can find out more about this error model and how to work with it in the

316

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

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

[diff] [blame]

317

"message": "A String", # A developer-facing error message, which should be in English. Any

318

# user-facing error message should be localized and sent in the

319

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

320

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

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

[diff] [blame]

321

"details": [ # A list of messages that carry the error details. There is a common set of

322

# message types for APIs to use.

323

{

324

"a_key": "", # Properties of the object. Contains field @type with type URL.

325

},

326

],

327

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

328

"response": { # The normal response of the operation in case of success. If the original

329

# method returns no data on success, such as `Delete`, the response is

330

# `google.protobuf.Empty`. If the original method is standard

331

# `Get`/`Create`/`Update`, the response should be the resource. For other

332

# methods, the response should have the type `XxxResponse`, where `Xxx`

333

# is the original method name. For example, if the original method name

334

# is `TakeSnapshot()`, the inferred response type is

335

# `TakeSnapshotResponse`.

336

"a_key": "", # Properties of the object. Contains field @type with type URL.

337

},

338

"metadata": { # Service-specific metadata associated with the operation. It typically

339

# contains progress information and common metadata such as create time.

340

# Some services might not provide such metadata. Any method that returns a

341

# long-running operation should document the metadata type, if any.

342

"a_key": "", # Properties of the object. Contains field @type with type URL.

343

},

Bu Sun Kim

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

[diff] [blame]

344

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

345

],

346

"tags": [ # User defined tags which can be used to group/filter models during listing

347

"A String",

348

],

349

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

350

"sizeBytes": "A String", # Output only. The size of the TFLite model

351

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).

352

# The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite

353

# Note: If you update the file in the original location, it is

354

# necessary to call UpdateModel for ML to pick up and validate the

355

# updated file.

356

},

357

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long

358

# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)

359

# and ASCII digits 0-9. It must start with a letter.

360

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

361

"name": "A String", # The resource name of the Model.

362

# Model names have the form `projects/{project_id}/models/{model_id}`

363

# The name is ignored when creating a model.

364

"state": { # State common to all model types. # State common to all model types.

365

# Includes publishing and validation information.

366

# Includes publishing and validation information.

367

"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.

368

# A model may have validation errors if there were problems during

369

# the model creation/update.

370

# e.g. in the case of a TfLiteModel, if a tflite model file was

371

# missing or in the wrong format.

372

# This field will be empty for valid models.

373

# different programming environments, including REST APIs and RPC APIs. It is

374

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

375

# three pieces of data: error code, error message, and error details.

376

#

377

# You can find out more about this error model and how to work with it in the

378

# [API Design Guide](https://cloud.google.com/apis/design/errors).

379

"message": "A String", # A developer-facing error message, which should be in English. Any

380

# user-facing error message should be localized and sent in the

381

# google.rpc.Status.details field, or localized by the client.

382

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

383

"details": [ # A list of messages that carry the error details. There is a common set of

384

# message types for APIs to use.

385

{

386

"a_key": "", # Properties of the object. Contains field @type with type URL.

387

},

388

],

Bu Sun Kim

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

[diff] [blame]

389

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

390

"published": True or False, # Indicates if this model has been published.

391

},

392

"etag": "A String", # Output only. See RFC7232

393

# https://tools.ietf.org/html/rfc7232#section-2.3

394

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

395

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

396

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

400

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

401

<pre>Lists the models

402

403

Args:

404

parent: string, Required. The name of the parent to list models for.

405

The parent must have the form `projects/{project_id}' (required)

Bu Sun Kim

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

[diff] [blame]

406

pageToken: string, The next_page_token value returned from a previous List request, if any.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

407

pageSize: integer, The maximum number of items to return

Bu Sun Kim

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

[diff] [blame]

408

filter: string, A filter for the list

409

e.g. 'tags: abc' to list models which are tagged with "abc"

Bu Sun Kim

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

[diff] [blame]

410

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

417

418

{ # The response for list models

419

"models": [ # The list of models

420

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

421

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

422

{ # This resource represents a long-running operation that is the result of a

423

# network API call.

424

"done": True or False, # If the value is `false`, it means the operation is still in progress.

425

# If `true`, the operation is completed, and either `error` or `response` is

426

# available.

427

"name": "A String", # The server-assigned name, which is only unique within the same service that

428

# originally returns it. If you use the default HTTP mapping, the

429

# `name` should be a resource name ending with `operations/{unique_id}`.

430

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

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

[diff] [blame]

431

# different programming environments, including REST APIs and RPC APIs. It is

432

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

433

# three pieces of data: error code, error message, and error details.

434

#

435

# You can find out more about this error model and how to work with it in the

436

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

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

[diff] [blame]

437

"message": "A String", # A developer-facing error message, which should be in English. Any

438

# user-facing error message should be localized and sent in the

439

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

440

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

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

[diff] [blame]

441

"details": [ # A list of messages that carry the error details. There is a common set of

442

# message types for APIs to use.

443

{

444

"a_key": "", # Properties of the object. Contains field @type with type URL.

445

},

446

],

447

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

448

"response": { # The normal response of the operation in case of success. If the original

449

# method returns no data on success, such as `Delete`, the response is

450

# `google.protobuf.Empty`. If the original method is standard

451

# `Get`/`Create`/`Update`, the response should be the resource. For other

452

# methods, the response should have the type `XxxResponse`, where `Xxx`

453

# is the original method name. For example, if the original method name

454

# is `TakeSnapshot()`, the inferred response type is

455

# `TakeSnapshotResponse`.

456

"a_key": "", # Properties of the object. Contains field @type with type URL.

457

},

458

"metadata": { # Service-specific metadata associated with the operation. It typically

459

# contains progress information and common metadata such as create time.

460

# Some services might not provide such metadata. Any method that returns a

461

# long-running operation should document the metadata type, if any.

462

"a_key": "", # Properties of the object. Contains field @type with type URL.

463

},

Bu Sun Kim

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

[diff] [blame]

464

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

465

],

466

"tags": [ # User defined tags which can be used to group/filter models during listing

467

"A String",

468

],

469

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

470

"sizeBytes": "A String", # Output only. The size of the TFLite model

471

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).

472

# The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite

473

# Note: If you update the file in the original location, it is

474

# necessary to call UpdateModel for ML to pick up and validate the

475

# updated file.

Bu Sun Kim

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

[diff] [blame]

476

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

477

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long

478

# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)

479

# and ASCII digits 0-9. It must start with a letter.

480

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

481

"name": "A String", # The resource name of the Model.

482

# Model names have the form `projects/{project_id}/models/{model_id}`

483

# The name is ignored when creating a model.

484

"state": { # State common to all model types. # State common to all model types.

485

# Includes publishing and validation information.

486

# Includes publishing and validation information.

487

"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.

488

# A model may have validation errors if there were problems during

489

# the model creation/update.

490

# e.g. in the case of a TfLiteModel, if a tflite model file was

491

# missing or in the wrong format.

492

# This field will be empty for valid models.

493

# different programming environments, including REST APIs and RPC APIs. It is

494

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

495

# three pieces of data: error code, error message, and error details.

496

#

497

# You can find out more about this error model and how to work with it in the

498

# [API Design Guide](https://cloud.google.com/apis/design/errors).

499

"message": "A String", # A developer-facing error message, which should be in English. Any

500

# user-facing error message should be localized and sent in the

501

# google.rpc.Status.details field, or localized by the client.

502

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

503

"details": [ # A list of messages that carry the error details. There is a common set of

504

# message types for APIs to use.

505

{

506

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"published": True or False, # Indicates if this model has been published.

511

},

512

"etag": "A String", # Output only. See RFC7232

513

# https://tools.ietf.org/html/rfc7232#section-2.3

514

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

515

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

516

},

Bu Sun Kim

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

[diff] [blame]

517

],

518

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

519

# more results in the list.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

525

<pre>Retrieves the next page of results.

526

527

Args:

528

previous_request: The request for the previous page. (required)

529

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

530

531

Returns:

532

A request object that you can call 'execute()' on to request the next

533

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

539

<pre>Updates a model. The longrunning operation will eventually return a Model.

Args:

Model names have the form `projects/{project_id}/models/{model_id}`

544

The name is ignored when creating a model. (required)

545

body: object, The request body.

546

The object takes the form of:

547

548

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

549

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

550

{ # This resource represents a long-running operation that is the result of a

551

# network API call.

552

"done": True or False, # If the value is `false`, it means the operation is still in progress.

553

# If `true`, the operation is completed, and either `error` or `response` is

554

# available.

555

"name": "A String", # The server-assigned name, which is only unique within the same service that

556

# originally returns it. If you use the default HTTP mapping, the

557

# `name` should be a resource name ending with `operations/{unique_id}`.

558

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

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

[diff] [blame]

559

# different programming environments, including REST APIs and RPC APIs. It is

560

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

561

# three pieces of data: error code, error message, and error details.

562

#

563

# You can find out more about this error model and how to work with it in the

564

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

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

[diff] [blame]

565

"message": "A String", # A developer-facing error message, which should be in English. Any

566

# user-facing error message should be localized and sent in the

567

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

568

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

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

[diff] [blame]

569

"details": [ # A list of messages that carry the error details. There is a common set of

570

# message types for APIs to use.

571

{

572

"a_key": "", # Properties of the object. Contains field @type with type URL.

573

},

574

],

575

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

576

"response": { # The normal response of the operation in case of success. If the original

577

# method returns no data on success, such as `Delete`, the response is

578

# `google.protobuf.Empty`. If the original method is standard

579

# `Get`/`Create`/`Update`, the response should be the resource. For other

580

# methods, the response should have the type `XxxResponse`, where `Xxx`

581

# is the original method name. For example, if the original method name

582

# is `TakeSnapshot()`, the inferred response type is

583

# `TakeSnapshotResponse`.

584

"a_key": "", # Properties of the object. Contains field @type with type URL.

585

},

586

"metadata": { # Service-specific metadata associated with the operation. It typically

587

# contains progress information and common metadata such as create time.

588

# Some services might not provide such metadata. Any method that returns a

589

# long-running operation should document the metadata type, if any.

590

"a_key": "", # Properties of the object. Contains field @type with type URL.

591

},

Bu Sun Kim

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

[diff] [blame]

592

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

593

],

594

"tags": [ # User defined tags which can be used to group/filter models during listing

595

"A String",

596

],

597

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

598

"sizeBytes": "A String", # Output only. The size of the TFLite model

599

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).

600

# The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite

601

# Note: If you update the file in the original location, it is

602

# necessary to call UpdateModel for ML to pick up and validate the

603

# updated file.

604

},

605

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long

606

# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)

607

# and ASCII digits 0-9. It must start with a letter.

608

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

609

"name": "A String", # The resource name of the Model.

610

# Model names have the form `projects/{project_id}/models/{model_id}`

611

# The name is ignored when creating a model.

612

"state": { # State common to all model types. # State common to all model types.

613

# Includes publishing and validation information.

614

# Includes publishing and validation information.

615

"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.

616

# A model may have validation errors if there were problems during

617

# the model creation/update.

618

# e.g. in the case of a TfLiteModel, if a tflite model file was

619

# missing or in the wrong format.

620

# This field will be empty for valid models.

621

# different programming environments, including REST APIs and RPC APIs. It is

622

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

623

# three pieces of data: error code, error message, and error details.

624

#

625

# You can find out more about this error model and how to work with it in the

626

# [API Design Guide](https://cloud.google.com/apis/design/errors).

627

"message": "A String", # A developer-facing error message, which should be in English. Any

628

# user-facing error message should be localized and sent in the

629

# google.rpc.Status.details field, or localized by the client.

630

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

631

"details": [ # A list of messages that carry the error details. There is a common set of

632

# message types for APIs to use.

633

{

634

"a_key": "", # Properties of the object. Contains field @type with type URL.

635

},

636

],

Bu Sun Kim

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

[diff] [blame]

637

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

638

"published": True or False, # Indicates if this model has been published.

639

},

640

"etag": "A String", # Output only. See RFC7232

641

# https://tools.ietf.org/html/rfc7232#section-2.3

642

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

643

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

644

}

Bu Sun Kim

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

[diff] [blame]

645

646

updateMask: string, The update mask

647

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

654

655

{ # This resource represents a long-running operation that is the result of a

656

# network API call.

Bu Sun Kim

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

[diff] [blame]

657

"done": True or False, # If the value is `false`, it means the operation is still in progress.

658

# If `true`, the operation is completed, and either `error` or `response` is

659

# available.

Bu Sun Kim