docs: update generated docs (#981)
diff --git a/docs/dyn/firebaseml_v1beta2.projects.models.html b/docs/dyn/firebaseml_v1beta2.projects.models.html
index a790292..4d2df99 100644
--- a/docs/dyn/firebaseml_v1beta2.projects.models.html
+++ b/docs/dyn/firebaseml_v1beta2.projects.models.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a model resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the models</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -105,82 +105,26 @@
The object takes the form of:
{ # An ML model hosted in Firebase ML
- "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.
- "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "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.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
- "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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}`.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
- "state": { # State common to all model types. # State common to all model types.
- # Includes publishing and validation information.
- # Includes publishing and validation information.
- "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.
- # 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.
+ "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "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.
+ "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}`.
+ "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.
# 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
@@ -188,19 +132,75 @@
},
],
},
- "published": True or False, # Indicates if this model has been published.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
},
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "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.
+ ],
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "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.
+ },
+ "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.
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "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.
+ "state": { # State common to all model types. # State common to all model types.
+ # Includes publishing and validation information.
+ # Includes publishing and validation information.
+ "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.
+ # 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.
+ # 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).
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
},
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
- }
+ "published": True or False, # Indicates if this model has been published.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -215,6 +215,27 @@
"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.
+ "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}`.
+ "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.
+ # 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).
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
"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
@@ -225,27 +246,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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}`.
"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
@@ -298,82 +298,26 @@
An object of the form:
{ # An ML model hosted in Firebase ML
- "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.
- "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "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.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
- "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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}`.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
- "state": { # State common to all model types. # State common to all model types.
- # Includes publishing and validation information.
- # Includes publishing and validation information.
- "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.
- # 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.
+ "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "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.
+ "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}`.
+ "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.
# 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
@@ -381,32 +325,88 @@
},
],
},
- "published": True or False, # Indicates if this model has been published.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
},
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "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.
+ ],
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "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.
+ },
+ "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.
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "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.
+ "state": { # State common to all model types. # State common to all model types.
+ # Includes publishing and validation information.
+ # Includes publishing and validation information.
+ "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.
+ # 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.
+ # 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).
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
},
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
- }</pre>
+ "published": True or False, # Indicates if this model has been published.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
<pre>Lists the models
Args:
parent: string, Required. The name of the parent to list models for.
The parent must have the form `projects/{project_id}' (required)
pageToken: string, The next_page_token value returned from a previous List request, if any.
+ pageSize: integer, The maximum number of items to return
filter: string, A filter for the list
e.g. 'tags: abc' to list models which are tagged with "abc"
- pageSize: integer, The maximum number of items to return
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -418,82 +418,26 @@
{ # The response for list models
"models": [ # The list of models
{ # An ML model hosted in Firebase ML
- "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.
- "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "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.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
- "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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}`.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
- "state": { # State common to all model types. # State common to all model types.
- # Includes publishing and validation information.
- # Includes publishing and validation information.
- "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.
- # 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.
+ "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "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.
+ "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}`.
+ "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.
# 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
@@ -501,19 +445,75 @@
},
],
},
- "published": True or False, # Indicates if this model has been published.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
},
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "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.
- },
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
+ ],
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "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.
},
+ "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.
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "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.
+ "state": { # State common to all model types. # State common to all model types.
+ # Includes publishing and validation information.
+ # Includes publishing and validation information.
+ "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.
+ # 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.
+ # 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).
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "published": True or False, # Indicates if this model has been published.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
+ },
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
# more results in the list.
@@ -546,82 +546,26 @@
The object takes the form of:
{ # An ML model hosted in Firebase ML
- "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.
- "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "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.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
- "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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}`.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
- "state": { # State common to all model types. # State common to all model types.
- # Includes publishing and validation information.
- # Includes publishing and validation information.
- "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.
- # 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.
+ "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "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.
+ "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}`.
+ "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.
# 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
@@ -629,19 +573,75 @@
},
],
},
- "published": True or False, # Indicates if this model has been published.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
},
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "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.
+ ],
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "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.
+ },
+ "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.
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "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.
+ "state": { # State common to all model types. # State common to all model types.
+ # Includes publishing and validation information.
+ # Includes publishing and validation information.
+ "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.
+ # 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.
+ # 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).
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
},
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
- }
+ "published": True or False, # Indicates if this model has been published.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
+}
updateMask: string, The update mask
x__xgafv: string, V1 error format.
@@ -657,6 +657,27 @@
"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.
+ "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}`.
+ "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.
+ # 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).
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
"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
@@ -667,27 +688,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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}`.
"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