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

blob: 15381eed52e905fd1ae101ab3595aa25839d98cf [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="firebaseml_v1beta2.html">Firebase ML API</a> . <a href="firebaseml_v1beta2.projects.html">projects</a> . <a href="firebaseml_v1beta2.projects.models.html">models</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	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	<p class="toc_element">
Bu Sun Kim	6502091	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	3e17f89	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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a model</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets a model resource.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	90	<code><a href="#list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	91	<p class="firstline">Lists the models</p>
				92	<p class="toc_element">
				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	<p class="toc_element">
				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	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
Bu Sun Kim	6502091	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	3e17f89	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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	107
				108	Args:
Dmitry Frenkel	3e17f89	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	6502091	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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	114	"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
				115	"sizeBytes": "A String", # Output only. The size of the TFLite model
				116	"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)
				117	"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.
				118	},
				119	"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
				120	"tags": [ # User defined tags which can be used to group/filter models during listing
				121	"A String",
				122	],
				123	"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.
				124	"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.
				125	"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
				126	{ # This resource represents a long-running operation that is the result of a network API call.
				127	"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.
				128	"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.
				129	"a_key": "", # Properties of the object. Contains field @type with type URL.
				130	},
				131	"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}`.
				132	"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.
				133	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	134	"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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	135	{
				136	"a_key": "", # Properties of the object. Contains field @type with type URL.
				137	},
				138	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	139	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				140	},
				141	"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`.
				142	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	143	},
				144	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	145	],
				146	"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
				147	"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
				148	"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
				149	"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.
				150	"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.
				151	"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.
				152	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				153	{
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	154	"a_key": "", # Properties of the object. Contains field @type with type URL.
				155	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	156	],
				157	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				158	},
				159	"published": True or False, # Indicates if this model has been published.
				160	},
				161	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	162
				163	x__xgafv: string, V1 error format.
				164	Allowed values
				165	1 - v1 error format
				166	2 - v2 error format
				167
				168	Returns:
				169	An object of the form:
				170
Dmitry Frenkel	3e17f89	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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	172	"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.
				173	"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.
				174	"a_key": "", # Properties of the object. Contains field @type with type URL.
				175	},
				176	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	177	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	178	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	179	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	180	{
				181	"a_key": "", # Properties of the object. Contains field @type with type URL.
				182	},
				183	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	184	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	185	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	186	"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`.
				187	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	188	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	189	}</pre>
				190	</div>
				191
				192	<div class="method">
				193	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				194	<pre>Deletes a model
				195
				196	Args:
Dmitry Frenkel	3e17f89	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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	198	x__xgafv: string, V1 error format.
				199	Allowed values
				200	1 - v1 error format
				201	2 - v2 error format
				202
				203	Returns:
				204	An object of the form:
				205
Dmitry Frenkel	3e17f89	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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	207	}</pre>
				208	</div>
				209
				210	<div class="method">
				211	<code class="details" id="get">get(name, x__xgafv=None)</code>
				212	<pre>Gets a model resource.
				213
				214	Args:
Dmitry Frenkel	3e17f89	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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	216	x__xgafv: string, V1 error format.
				217	Allowed values
				218	1 - v1 error format
				219	2 - v2 error format
				220
				221	Returns:
				222	An object of the form:
				223
				224	{ # An ML model hosted in Firebase ML
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	225	"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
				226	"sizeBytes": "A String", # Output only. The size of the TFLite model
				227	"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)
				228	"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.
				229	},
				230	"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
				231	"tags": [ # User defined tags which can be used to group/filter models during listing
				232	"A String",
				233	],
				234	"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.
				235	"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.
				236	"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
				237	{ # This resource represents a long-running operation that is the result of a network API call.
				238	"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.
				239	"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.
				240	"a_key": "", # Properties of the object. Contains field @type with type URL.
				241	},
				242	"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}`.
				243	"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.
				244	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	245	"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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	246	{
				247	"a_key": "", # Properties of the object. Contains field @type with type URL.
				248	},
				249	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	250	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				251	},
				252	"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`.
				253	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	254	},
				255	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	256	],
				257	"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
				258	"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
				259	"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
				260	"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.
				261	"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.
				262	"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.
				263	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				264	{
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	265	"a_key": "", # Properties of the object. Contains field @type with type URL.
				266	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	267	],
				268	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				269	},
				270	"published": True or False, # Indicates if this model has been published.
				271	},
				272	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	273	</div>
				274
				275	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	276	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	277	<pre>Lists the models
				278
				279	Args:
Dmitry Frenkel	3e17f89	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)
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	281	pageSize: integer, The maximum number of items to return
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	282	pageToken: string, The next_page_token value returned from a previous List request, if any.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	283	filter: string, A filter for the list e.g. 'tags: abc' to list models which are tagged with "abc"
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	284	x__xgafv: string, V1 error format.
				285	Allowed values
				286	1 - v1 error format
				287	2 - v2 error format
				288
				289	Returns:
				290	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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	295	"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
				296	"sizeBytes": "A String", # Output only. The size of the TFLite model
				297	"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)
				298	"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.
				299	},
				300	"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
				301	"tags": [ # User defined tags which can be used to group/filter models during listing
				302	"A String",
				303	],
				304	"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.
				305	"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.
				306	"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
				307	{ # This resource represents a long-running operation that is the result of a network API call.
				308	"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.
				309	"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.
				310	"a_key": "", # Properties of the object. Contains field @type with type URL.
				311	},
				312	"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}`.
				313	"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.
				314	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	315	"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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	316	{
				317	"a_key": "", # Properties of the object. Contains field @type with type URL.
				318	},
				319	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	320	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				321	},
				322	"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`.
				323	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	324	},
				325	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	326	],
				327	"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
				328	"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
				329	"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
				330	"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.
				331	"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.
				332	"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.
				333	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				334	{
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	335	"a_key": "", # Properties of the object. Contains field @type with type URL.
				336	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	337	],
				338	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				339	},
				340	"published": True or False, # Indicates if this model has been published.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	341	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	342	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	343	],
Yoshi Automation Bot	0d561ef	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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	345	}</pre>
				346	</div>
				347
				348	<div class="method">
				349	<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.
				359	</pre>
				360	</div>
				361
				362	<div class="method">
				363	<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	3e17f89	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	6502091	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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	372	"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
				373	"sizeBytes": "A String", # Output only. The size of the TFLite model
				374	"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)
				375	"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.
				376	},
				377	"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
				378	"tags": [ # User defined tags which can be used to group/filter models during listing
				379	"A String",
				380	],
				381	"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.
				382	"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.
				383	"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
				384	{ # This resource represents a long-running operation that is the result of a network API call.
				385	"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.
				386	"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.
				387	"a_key": "", # Properties of the object. Contains field @type with type URL.
				388	},
				389	"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}`.
				390	"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.
				391	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	392	"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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	393	{
				394	"a_key": "", # Properties of the object. Contains field @type with type URL.
				395	},
				396	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	397	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				398	},
				399	"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`.
				400	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	401	},
				402	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	403	],
				404	"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
				405	"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
				406	"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
				407	"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.
				408	"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.
				409	"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.
				410	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				411	{
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	412	"a_key": "", # Properties of the object. Contains field @type with type URL.
				413	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	414	],
				415	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				416	},
				417	"published": True or False, # Indicates if this model has been published.
				418	},
				419	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	420
				421	updateMask: string, The update mask
				422	x__xgafv: string, V1 error format.
				423	Allowed values
				424	1 - v1 error format
				425	2 - v2 error format
				426
				427	Returns:
				428	An object of the form:
				429
Dmitry Frenkel	3e17f89	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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	431	"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.
				432	"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.
				433	"a_key": "", # Properties of the object. Contains field @type with type URL.
				434	},
				435	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	436	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	437	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	438	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	439	{
				440	"a_key": "", # Properties of the object. Contains field @type with type URL.
				441	},
				442	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	443	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	444	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	445	"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`.
				446	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	447	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	448	}</pre>
				449	</div>
				450
				451	</body></html>