diff --git a/discovery/firebaseml-v1.json b/discovery/firebaseml-v1.json index 9f91295301..6922fa5a96 100644 --- a/discovery/firebaseml-v1.json +++ b/discovery/firebaseml-v1.json @@ -108,7 +108,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "firebaseml.operations.cancel", @@ -136,7 +136,7 @@ ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1/operations/{operationsId}", "httpMethod": "DELETE", "id": "firebaseml.operations.delete", @@ -161,7 +161,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "flatPath": "v1/operations", "httpMethod": "GET", "id": "firebaseml.operations.list", @@ -204,7 +204,7 @@ } } }, - "revision": "20200527", + "revision": "20200803", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -214,7 +214,7 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "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 `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -238,7 +238,7 @@ "type": "object" }, "ModelOperationMetadata": { - "description": "This is returned in the longrunning operations\nfor create/update.", + "description": "This is returned in the longrunning operations for create/update.", "id": "ModelOperationMetadata", "properties": { "basicOperationStatus": { @@ -255,18 +255,18 @@ "type": "string" }, "name": { - "description": "The name of the model we are creating/updating\nThe name must have the form `projects/{project_id}/models/{model_id}`", + "description": "The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}`", "type": "string" } }, "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "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.", "type": "boolean" }, "error": { @@ -278,11 +278,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "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.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "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}`.", "type": "string" }, "response": { @@ -290,14 +290,14 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "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`.", "type": "object" } }, "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "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).", "id": "Status", "properties": { "code": { @@ -306,7 +306,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -317,7 +317,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "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.", "type": "string" } }, diff --git a/discovery/firebaseml-v1beta2.json b/discovery/firebaseml-v1beta2.json index 7bbff1743c..05f4dd879e 100644 --- a/discovery/firebaseml-v1beta2.json +++ b/discovery/firebaseml-v1beta2.json @@ -110,7 +110,7 @@ "models": { "methods": { "create": { - "description": "Creates a model in Firebase ML.\nThe longrunning operation will eventually return a Model", + "description": "Creates a model in Firebase ML. The longrunning operation will eventually return a Model", "flatPath": "v1beta2/projects/{projectsId}/models", "httpMethod": "POST", "id": "firebaseml.projects.models.create", @@ -119,7 +119,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent project resource where the model is to be created.\nThe parent must have the form `projects/{project_id}`", + "description": "Required. The parent project resource where the model is to be created. The parent must have the form `projects/{project_id}`", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -147,7 +147,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the model to delete.\nThe name must have the form `projects/{project_id}/models/{model_id}`", + "description": "Required. The name of the model to delete. The name must have the form `projects/{project_id}/models/{model_id}`", "location": "path", "pattern": "^projects/[^/]+/models/[^/]+$", "required": true, @@ -172,7 +172,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the model to get.\nThe name must have the form `projects/{project_id}/models/{model_id}`", + "description": "Required. The name of the model to get. The name must have the form `projects/{project_id}/models/{model_id}`", "location": "path", "pattern": "^projects/[^/]+/models/[^/]+$", "required": true, @@ -197,7 +197,7 @@ ], "parameters": { "filter": { - "description": "A filter for the list\ne.g. 'tags: abc' to list models which are tagged with \"abc\"", + "description": "A filter for the list e.g. 'tags: abc' to list models which are tagged with \"abc\"", "location": "query", "type": "string" }, @@ -213,7 +213,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent to list models for.\nThe parent must have the form `projects/{project_id}'", + "description": "Required. The name of the parent to list models for. The parent must have the form `projects/{project_id}'", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -238,7 +238,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Model.\nModel names have the form `projects/{project_id}/models/{model_id}`\nThe name is ignored when creating a model.", + "description": "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.", "location": "path", "pattern": "^projects/[^/]+/models/[^/]+$", "required": true, @@ -267,7 +267,7 @@ "operations": { "methods": { "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta2/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "id": "firebaseml.projects.operations.get", @@ -296,11 +296,11 @@ } } }, - "revision": "20200722", + "revision": "20200803", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "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 `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -317,7 +317,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, @@ -332,32 +332,36 @@ "items": { "$ref": "Operation" }, + "readOnly": true, "type": "array" }, "createTime": { "description": "Output only. Timestamp when this model was created in Firebase ML.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "displayName": { - "description": "Required. The name of the model to create. The name can be up to 32 characters long\nand can consist only of ASCII Latin letters A-Z and a-z, underscores(_)\nand ASCII digits 0-9. It must start with a letter.", + "description": "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.", "type": "string" }, "etag": { - "description": "Output only. See RFC7232\nhttps://tools.ietf.org/html/rfc7232#section-2.3", + "description": "Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3", + "readOnly": true, "type": "string" }, "modelHash": { "description": "Output only. The model_hash will change if a new file is available for download.", + "readOnly": true, "type": "string" }, "name": { - "description": "The resource name of the Model.\nModel names have the form `projects/{project_id}/models/{model_id}`\nThe name is ignored when creating a model.", + "description": "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.", "type": "string" }, "state": { "$ref": "ModelState", - "description": "State common to all model types.\nIncludes publishing and validation information." + "description": "State common to all model types. Includes publishing and validation information." }, "tags": { "description": "User defined tags which can be used to group/filter models during listing", @@ -373,13 +377,14 @@ "updateTime": { "description": "Output only. Timestamp when this model was updated in Firebase ML.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, "ModelOperationMetadata": { - "description": "This is returned in the longrunning operations\nfor create/update.", + "description": "This is returned in the longrunning operations for create/update.", "id": "ModelOperationMetadata", "properties": { "basicOperationStatus": { @@ -396,14 +401,14 @@ "type": "string" }, "name": { - "description": "The name of the model we are creating/updating\nThe name must have the form `projects/{project_id}/models/{model_id}`", + "description": "The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}`", "type": "string" } }, "type": "object" }, "ModelState": { - "description": "State common to all model types.\nIncludes publishing and validation information.", + "description": "State common to all model types. Includes publishing and validation information.", "id": "ModelState", "properties": { "published": { @@ -412,17 +417,18 @@ }, "validationError": { "$ref": "Status", - "description": "Output only. Indicates the latest validation error on the model if any.\nA model may have validation errors if there were problems during\nthe model creation/update.\ne.g. in the case of a TfLiteModel, if a tflite model file was\nmissing or in the wrong format.\nThis field will be empty for valid models." + "description": "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.", + "readOnly": true } }, "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "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.", "type": "boolean" }, "error": { @@ -434,11 +440,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "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.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "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}`.", "type": "string" }, "response": { @@ -446,14 +452,14 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "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`.", "type": "object" } }, "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "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).", "id": "Status", "properties": { "code": { @@ -462,7 +468,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -473,7 +479,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "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.", "type": "string" } }, @@ -484,15 +490,17 @@ "id": "TfLiteModel", "properties": { "gcsTfliteUri": { - "description": "The TfLite file containing the model. (Stored in Google Cloud).\nThe gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite\nNote: If you update the file in the original location, it is\nnecessary to call UpdateModel for ML to pick up and validate the\nupdated file.", + "description": "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.", "type": "string" }, "managedUpload": { - "description": "Output only. A boolean indicating that this model was uploaded from the console.\nRead only", + "description": "Output only. A boolean indicating that this model was uploaded from the console. Read only", + "readOnly": true, "type": "boolean" }, "sizeBytes": { "description": "Output only. The size of the TFLite model", + "readOnly": true, "type": "string" } }, diff --git a/src/apis/firebaseml/v1.ts b/src/apis/firebaseml/v1.ts index 45459e09fe..d9fc415fb3 100644 --- a/src/apis/firebaseml/v1.ts +++ b/src/apis/firebaseml/v1.ts @@ -132,7 +132,7 @@ export namespace firebaseml_v1 { */ export interface Schema$CancelOperationRequest {} /** - * 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 `{}`. + * 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 `{}`. */ export interface Schema$Empty {} /** @@ -171,7 +171,7 @@ export namespace firebaseml_v1 { */ error?: Schema$Status; /** - * 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. + * 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. */ metadata?: {[key: string]: any} | null; /** @@ -179,12 +179,12 @@ export namespace firebaseml_v1 { */ name?: string | null; /** - * 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`. + * 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`. */ response?: {[key: string]: any} | null; } /** - * 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 `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). */ export interface Schema$Status { /** @@ -192,7 +192,7 @@ export namespace firebaseml_v1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -209,7 +209,7 @@ export namespace firebaseml_v1 { /** * firebaseml.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @example * // Before running the sample: * // - Enable the API at: @@ -468,7 +468,7 @@ export namespace firebaseml_v1 { /** * firebaseml.operations.list - * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/firebaseml/v1beta2.ts b/src/apis/firebaseml/v1beta2.ts index 98c9880703..56ef60fb3d 100644 --- a/src/apis/firebaseml/v1beta2.ts +++ b/src/apis/firebaseml/v1beta2.ts @@ -128,7 +128,7 @@ export namespace firebaseml_v1beta2 { } /** - * 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 `{}`. + * 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 `{}`. */ export interface Schema$Empty {} /** @@ -225,7 +225,7 @@ export namespace firebaseml_v1beta2 { */ error?: Schema$Status; /** - * 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. + * 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. */ metadata?: {[key: string]: any} | null; /** @@ -233,12 +233,12 @@ export namespace firebaseml_v1beta2 { */ name?: string | null; /** - * 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`. + * 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`. */ response?: {[key: string]: any} | null; } /** - * 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 `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). */ export interface Schema$Status { /** @@ -246,7 +246,7 @@ export namespace firebaseml_v1beta2 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -316,8 +316,7 @@ export namespace firebaseml_v1beta2 { * * // Do the magic * const res = await firebaseml.projects.models.create({ - * // Required. The parent project resource where the model is to be created. - * // The parent must have the form `projects/{project_id}` + * // Required. The parent project resource where the model is to be created. The parent must have the form `projects/{project_id}` * parent: 'projects/my-project', * * // Request body metadata @@ -470,8 +469,7 @@ export namespace firebaseml_v1beta2 { * * // Do the magic * const res = await firebaseml.projects.models.delete({ - * // Required. The name of the model to delete. - * // The name must have the form `projects/{project_id}/models/{model_id}` + * // Required. The name of the model to delete. The name must have the form `projects/{project_id}/models/{model_id}` * name: 'projects/my-project/models/my-model', * }); * console.log(res.data); @@ -597,8 +595,7 @@ export namespace firebaseml_v1beta2 { * * // Do the magic * const res = await firebaseml.projects.models.get({ - * // Required. The name of the model to get. - * // The name must have the form `projects/{project_id}/models/{model_id}` + * // Required. The name of the model to get. The name must have the form `projects/{project_id}/models/{model_id}` * name: 'projects/my-project/models/my-model', * }); * console.log(res.data); @@ -735,15 +732,13 @@ export namespace firebaseml_v1beta2 { * * // Do the magic * const res = await firebaseml.projects.models.list({ - * // A filter for the list - * // e.g. 'tags: abc' to list models which are tagged with "abc" + * // A filter for the list e.g. 'tags: abc' to list models which are tagged with "abc" * filter: 'placeholder-value', * // The maximum number of items to return * pageSize: 'placeholder-value', * // The next_page_token value returned from a previous List request, if any. * pageToken: 'placeholder-value', - * // Required. The name of the parent to list models for. - * // The parent must have the form `projects/{project_id}' + * // Required. The name of the parent to list models for. The parent must have the form `projects/{project_id}' * parent: 'projects/my-project', * }); * console.log(res.data); @@ -881,9 +876,7 @@ export namespace firebaseml_v1beta2 { * * // Do the magic * const res = await firebaseml.projects.models.patch({ - * // 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. + * // 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. * name: 'projects/my-project/models/my-model', * // The update mask * updateMask: 'placeholder-value', @@ -1080,7 +1073,7 @@ export namespace firebaseml_v1beta2 { /** * firebaseml.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: