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

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

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

[diff] [blame]

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Creates a model in Firebase ML. The longrunning operation will eventually return a Model</p>

Bu Sun Kim

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

[diff] [blame]

83

84

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

85

<p class="firstline">Deletes a model</p>

86

87

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

88

<p class="firstline">Gets a model resource.</p>

89

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

90

<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]

91

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

92

93

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

94

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

95

96

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

97

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

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

105

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

106

<pre>Creates a model in Firebase ML. The longrunning operation will eventually return a Model

Bu Sun Kim

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

[diff] [blame]

107

108

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

109

parent: string, Required. The parent project resource where the model is to be created. The parent must have the form `projects/{project_id}` (required)

Bu Sun Kim

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

[diff] [blame]

110

body: object, The request body.

111

The object takes the form of:

112

113

{ # An ML model hosted in Firebase ML

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

114

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

115

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

116

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

117

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

118

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

119

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

120

},

121

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

122

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

123

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

124

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

125

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

126

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

127

{

128

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

129

},

130

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

131

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

132

},

133

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

134

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

135

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

136

"A String",

137

],

138

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

139

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

140

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

141

{ # This resource represents a long-running operation that is the result of a network API call.

142

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

143

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

144

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

145

{

146

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

147

},

148

],

149

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

150

},

151

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

152

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

153

},

154

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

155

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

156

},

157

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

158

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

159

},

160

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

161

}

Bu Sun Kim

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

[diff] [blame]

162

163

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

170

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

171

{ # This resource represents a long-running operation that is the result of a network API call.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

172

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

173

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

174

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

175

{

176

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

177

},

178

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

179

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

180

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

181

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

182

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

183

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

184

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

185

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

Bu Sun Kim

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

[diff] [blame]

186

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

187

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

188

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

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>

194

<pre>Deletes a model

195

196

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

197

name: string, Required. The name of the model to delete. The name must have the form `projects/{project_id}/models/{model_id}` (required)

Bu Sun Kim

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

[diff] [blame]

198

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

205

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

206

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

212

<pre>Gets a model resource.

213

214

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

215

name: string, Required. The name of the model to get. The name must have the form `projects/{project_id}/models/{model_id}` (required)

Bu Sun Kim

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

[diff] [blame]

216

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

223

224

{ # An ML model hosted in Firebase ML

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

225

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

226

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

227

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

228

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

229

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

230

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

231

},

232

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

233

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

234

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

235

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

236

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

237

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

238

{

239

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

240

},

241

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

242

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

243

},

244

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

245

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

246

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

247

"A String",

248

],

249

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

250

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

251

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

252

{ # This resource represents a long-running operation that is the result of a network API call.

253

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

254

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

255

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

256

{

257

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

258

},

259

],

260

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

261

},

262

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

263

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

264

},

265

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

266

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

267

},

268

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

269

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

270

},

271

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

272

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

276

<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]

277

<pre>Lists the models

278

279

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

280

parent: string, Required. The name of the parent to list models for. The parent must have the form `projects/{project_id}' (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

281

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

282

pageSize: integer, The maximum number of items to return

283

filter: string, A filter for the list e.g. 'tags: abc' to list models which are tagged with "abc"

Bu Sun Kim

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

[diff] [blame]

284

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

291

292

{ # The response for list models

293

"models": [ # The list of models

294

{ # An ML model hosted in Firebase ML

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

295

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

296

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

297

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

298

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

299

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

300

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

301

},

302

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

303

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

304

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

305

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

306

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

307

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

308

{

309

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

310

},

311

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

312

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

313

},

314

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

315

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

316

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

317

"A String",

318

],

319

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

320

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

321

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

322

{ # This resource represents a long-running operation that is the result of a network API call.

323

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

324

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

325

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

326

{

327

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

328

},

329

],

330

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

331

},

332

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

333

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

334

},

335

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

336

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

337

},

338

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

339

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

340

},

341

],

Bu Sun Kim

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

[diff] [blame]

342

},

Bu Sun Kim

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

[diff] [blame]

343

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

344

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

350

<pre>Retrieves the next page of results.

351

352

Args:

353

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

354

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

355

356

Returns:

357

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

358

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>

364

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

365

366

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

367

name: string, The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model. (required)

Bu Sun Kim

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

[diff] [blame]

368

body: object, The request body.

369

The object takes the form of:

370

371

{ # An ML model hosted in Firebase ML

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

372

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

373

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

374

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

375

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

376

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

377

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

378

},

379

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

380

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

381

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

382

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

383

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

384

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

385

{

386

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

387

},

388

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

389

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

390

},

391

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

392

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

393

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

394

"A String",

395

],

396

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

397

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

398

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

399

{ # This resource represents a long-running operation that is the result of a network API call.

400

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

401

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

402

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

403

{

404

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

405

},

406

],

407

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

408

},

409

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

410

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

411

},

412

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

413

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

414

},

415

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

416

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

417

},

418

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

419

}

Bu Sun Kim

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

[diff] [blame]

420

421

updateMask: string, The update mask

422

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

429

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

430

{ # This resource represents a long-running operation that is the result of a network API call.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

431

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

432

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

433

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

434

{

435

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

436

},

437

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

438

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

439

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

440

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

441

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

442

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

443

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

444

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

Bu Sun Kim

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

[diff] [blame]

445

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

446

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

447

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim