{ "basePath": "", "id": "ml:v1beta1", "revision": "20170729", "documentationLink": "https://cloud.google.com/ml/", "discoveryVersion": "v1", "version_module": "True", "schemas": { "GoogleIamV1__TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleIamV1__TestIamPermissionsRequest" }, "GoogleCloudMlV1beta1__ManualScaling": { "description": "Options for manually scaling a model.", "type": "object", "properties": { "nodes": { "format": "int32", "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle plus the cost for each prediction performed.", "type": "integer" } }, "id": "GoogleCloudMlV1beta1__ManualScaling" }, "GoogleIamV1__LogConfig": { "description": "Specifies what kind of log the caller must write", "type": "object", "properties": { "dataAccess": { "$ref": "GoogleIamV1_LogConfig_DataAccessOptions", "description": "Data access options." }, "cloudAudit": { "$ref": "GoogleIamV1_LogConfig_CloudAuditOptions", "description": "Cloud audit options." }, "counter": { "$ref": "GoogleIamV1_LogConfig_CounterOptions", "description": "Counter options." } }, "id": "GoogleIamV1__LogConfig" }, "GoogleCloudMlV1__AutoScaling": { "description": "Options for automatically scaling a model.", "type": "object", "properties": { "minNodes": { "format": "int32", "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.", "type": "integer" } }, "id": "GoogleCloudMlV1__AutoScaling" }, "GoogleRpc__Status": { "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", "type": "object", "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "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.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "type": "array" } }, "id": "GoogleRpc__Status" }, "GoogleCloudMlV1beta1__PredictRequest": { "description": "Request for predictions to be issued against a trained model.\n\nThe body of the request is a single JSON object with a single top-level\nfield:\n\n\u003cdl\u003e\n \u003cdt\u003einstances\u003c/dt\u003e\n \u003cdd\u003eA JSON array containing values representing the instances to use for\n prediction.\u003c/dd\u003e\n\u003c/dl\u003e\n\nThe structure of each element of the instances list is determined by your\nmodel's input definition. Instances can include named inputs or can contain\nonly unlabeled values.\n\nNot all data includes named inputs. Some instances will be simple\nJSON values (boolean, number, or string). However, instances are often lists\nof simple values, or complex nested lists. Here are some examples of request\nbodies:\n\nCSV data with each row encoded as a string value:\n\u003cpre\u003e\n{\"instances\": [\"1.0,true,\\\\\"x\\\\\"\", \"-2.0,false,\\\\\"y\\\\\"\"]}\n\u003c/pre\u003e\nPlain text:\n\u003cpre\u003e\n{\"instances\": [\"the quick brown fox\", \"la bruja le dio\"]}\n\u003c/pre\u003e\nSentences encoded as lists of words (vectors of strings):\n\u003cpre\u003e\n{\n \"instances\": [\n [\"the\",\"quick\",\"brown\"],\n [\"la\",\"bruja\",\"le\"],\n ...\n ]\n}\n\u003c/pre\u003e\nFloating point scalar values:\n\u003cpre\u003e\n{\"instances\": [0.0, 1.1, 2.2]}\n\u003c/pre\u003e\nVectors of integers:\n\u003cpre\u003e\n{\n \"instances\": [\n [0, 1, 2],\n [3, 4, 5],\n ...\n ]\n}\n\u003c/pre\u003e\nTensors (in this case, two-dimensional tensors):\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [0, 1, 2],\n [3, 4, 5]\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nImages can be represented different ways. In this encoding scheme the first\ntwo dimensions represent the rows and columns of the image, and the third\ncontains lists (vectors) of the R, G, and B values for each pixel.\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nJSON strings must be encoded as UTF-8. To send binary data, you must\nbase64-encode the data and mark it as binary. To mark a JSON string\nas binary, replace it with a JSON object with a single attribute named `b64`:\n\u003cpre\u003e{\"b64\": \"...\"} \u003c/pre\u003e\nFor example:\n\nTwo Serialized tf.Examples (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"X5ad6u\"}, {\"b64\": \"IA9j4nx\"}]}\n\u003c/pre\u003e\nTwo JPEG image byte strings (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"ASa8asdf\"}, {\"b64\": \"JLK7ljk3\"}]}\n\u003c/pre\u003e\nIf your data includes named references, format each instance as a JSON object\nwith the named references as the keys:\n\nJSON input data to be preprocessed:\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"a\": 1.0,\n \"b\": true,\n \"c\": \"x\"\n },\n {\n \"a\": -2.0,\n \"b\": false,\n \"c\": \"y\"\n }\n ]\n}\n\u003c/pre\u003e\nSome models have an underlying TensorFlow graph that accepts multiple input\ntensors. In this case, you should use the names of JSON name/value pairs to\nidentify the input tensors, as shown in the following exmaples:\n\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(base64-encoded string):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": {\"b64\": \"ASa8asdf\"}\n },\n {\n \"tag\": \"car\",\n \"image\": {\"b64\": \"JLK7ljk3\"}\n }\n ]\n}\n\u003c/pre\u003e\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(3-dimensional array of 8-bit ints):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ]\n },\n {\n \"tag\": \"car\",\n \"image\": [\n [\n [255, 0, 102],\n [255, 0, 97],\n ...\n ],\n [\n [254, 1, 101],\n [254, 2, 93],\n ...\n ],\n ...\n ]\n },\n ...\n ]\n}\n\u003c/pre\u003e\nIf the call is successful, the response body will contain one prediction\nentry per instance in the request body. If prediction fails for any\ninstance, the response body will contain no predictions and will contian\na single error entry instead.", "type": "object", "properties": { "httpBody": { "$ref": "GoogleApi__HttpBody", "description": "\nRequired. The prediction request body." } }, "id": "GoogleCloudMlV1beta1__PredictRequest" }, "GoogleApi__HttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.", "type": "object", "properties": { "extensions": { "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "type": "array" }, "data": { "format": "byte", "description": "HTTP body binary data.", "type": "string" }, "contentType": { "description": "The HTTP Content-Type string representing the content type of the body.", "type": "string" } }, "id": "GoogleApi__HttpBody" }, "GoogleCloudMlV1beta1__PredictionInput": { "description": "Represents input parameters for a prediction job.", "type": "object", "properties": { "region": { "description": "Required. The Google Compute Engine region to run the prediction job in.", "type": "string" }, "versionName": { "type": "string", "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`" }, "modelName": { "description": "Use this field if you want to use the default version for the specified\nmodel. The string must use the following format:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003e[YOUR_MODEL]\u003c/var\u003e\"`", "type": "string" }, "outputPath": { "description": "Required. The output Google Cloud Storage location.", "type": "string" }, "maxWorkerCount": { "format": "int64", "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.", "type": "string" }, "uri": { "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.", "type": "string" }, "dataFormat": { "enumDescriptions": [ "Unspecified format.", "The source file is a text file with instances separated by the\nnew-line character.", "The source file is a TFRecord file.", "The source file is a GZIP-compressed TFRecord file." ], "enum": [ "DATA_FORMAT_UNSPECIFIED", "TEXT", "TF_RECORD", "TF_RECORD_GZIP" ], "description": "Required. The format of the input data files.", "type": "string" }, "runtimeVersion": { "type": "string", "description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri." }, "batchSize": { "type": "string", "format": "int64", "description": "Optional. Number of records per batch, defaults to 64.\nThe service will buffer batch_size number of records in memory before\ninvoking one Tensorflow prediction call internally. So take the record\nsize and memory available into consideration when setting this parameter." }, "inputPaths": { "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudMlV1beta1__PredictionInput" }, "GoogleCloudMlV1beta1__ListJobsResponse": { "description": "Response message for the ListJobs method.", "type": "object", "properties": { "nextPageToken": { "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.", "type": "string" }, "jobs": { "description": "The list of jobs.", "items": { "$ref": "GoogleCloudMlV1beta1__Job" }, "type": "array" } }, "id": "GoogleCloudMlV1beta1__ListJobsResponse" }, "GoogleCloudMlV1beta1__Version": { "type": "object", "properties": { "lastUseTime": { "format": "google-datetime", "description": "Output only. The time the version was last used for prediction.", "type": "string" }, "runtimeVersion": { "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.", "type": "string" }, "description": { "description": "Optional. The description specified for the version when it was created.", "type": "string" }, "deploymentUri": { "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformation.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1beta1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000.", "type": "string" }, "autoScaling": { "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes.", "$ref": "GoogleCloudMlV1beta1__AutoScaling" }, "isDefault": { "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).", "type": "boolean" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the version was created.", "type": "string" }, "manualScaling": { "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes.", "$ref": "GoogleCloudMlV1beta1__ManualScaling" }, "state": { "enum": [ "UNKNOWN", "READY", "CREATING", "FAILED" ], "description": "Output only. The state of a version.", "type": "string", "enumDescriptions": [ "The version state is unspecified.", "The version is ready for prediction.", "The version is still in the process of creation.", "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure." ] }, "name": { "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.", "type": "string" }, "errorMessage": { "description": "Output only. The details of a failure or a cancellation.", "type": "string" } }, "id": "GoogleCloudMlV1beta1__Version", "description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).\n\nNext ID: 18" }, "GoogleCloudMlV1beta1__ListVersionsResponse": { "properties": { "versions": { "items": { "$ref": "GoogleCloudMlV1beta1__Version" }, "type": "array", "description": "The list of versions." }, "nextPageToken": { "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.", "type": "string" } }, "id": "GoogleCloudMlV1beta1__ListVersionsResponse", "description": "Response message for the ListVersions method.", "type": "object" }, "GoogleIamV1__TestIamPermissionsResponse": { "properties": { "permissions": { "items": { "type": "string" }, "type": "array", "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed." } }, "id": "GoogleIamV1__TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "type": "object" }, "GoogleIamV1__SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", "$ref": "GoogleIamV1__Policy" }, "updateMask": { "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", "type": "string" } }, "id": "GoogleIamV1__SetIamPolicyRequest" }, "GoogleCloudMlV1beta1__CancelJobRequest": { "properties": {}, "id": "GoogleCloudMlV1beta1__CancelJobRequest", "description": "Request message for the CancelJob method.", "type": "object" }, "GoogleCloudMlV1beta1__Model": { "description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.\n\nNext ID: 8", "type": "object", "properties": { "defaultVersion": { "$ref": "GoogleCloudMlV1beta1__Version", "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault)." }, "regions": { "description": "Optional. The list of regions where the model is going to be deployed.\nCurrently only one region per model is supported.\nDefaults to 'us-central1' if nothing is set.\nNote:\n* No matter where a model is deployed, it can always be accessed by\n users from anywhere, both for online and batch prediction.\n* The region for a batch prediction job is set by the region field when\n submitting the batch prediction job and does not take its value from\n this field.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in.", "type": "string" }, "description": { "description": "Optional. The description specified for the model when it was created.", "type": "string" }, "onlinePredictionLogging": { "type": "boolean", "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false." } }, "id": "GoogleCloudMlV1beta1__Model" }, "GoogleIamV1__Policy": { "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", "type": "object", "properties": { "etag": { "format": "byte", "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", "type": "string" }, "iamOwned": { "type": "boolean" }, "rules": { "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.", "items": { "$ref": "GoogleIamV1__Rule" }, "type": "array" }, "version": { "format": "int32", "description": "Version of the `Policy`. The default version is 0.", "type": "integer" }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "GoogleIamV1__AuditConfig" }, "type": "array" }, "bindings": { "items": { "$ref": "GoogleIamV1__Binding" }, "type": "array", "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error." } }, "id": "GoogleIamV1__Policy" }, "GoogleCloudMlV1beta1__Job": { "id": "GoogleCloudMlV1beta1__Job", "description": "Represents a training or prediction job.\n\nNext ID: 16", "type": "object", "properties": { "trainingOutput": { "$ref": "GoogleCloudMlV1beta1__TrainingOutput", "description": "The current training job result." }, "createTime": { "format": "google-datetime", "description": "Output only. When the job was created.", "type": "string" }, "trainingInput": { "description": "Input parameters to create a training job.", "$ref": "GoogleCloudMlV1beta1__TrainingInput" }, "predictionInput": { "description": "Input parameters to create a prediction job.", "$ref": "GoogleCloudMlV1beta1__PredictionInput" }, "state": { "enum": [ "STATE_UNSPECIFIED", "QUEUED", "PREPARING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED" ], "description": "Output only. The detailed state of a job.", "type": "string", "enumDescriptions": [ "The job state is unspecified.", "The job has been just created and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.\n`error_message` should contain the details of the failure.", "The job is being cancelled.\n`error_message` should describe the reason for the cancellation.", "The job has been cancelled.\n`error_message` should describe the reason for the cancellation." ] }, "errorMessage": { "description": "Output only. The details of a failure or a cancellation.", "type": "string" }, "jobId": { "description": "Required. The user-specified id of the job.", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. When the job processing was completed." }, "startTime": { "format": "google-datetime", "description": "Output only. When the job processing was started.", "type": "string" }, "predictionOutput": { "$ref": "GoogleCloudMlV1beta1__PredictionOutput", "description": "The current prediction job result." } } }, "GoogleCloudMlV1beta1__TrainingInput": { "description": "Represents input parameters for a training job.", "type": "object", "properties": { "pythonModule": { "description": "Required. The Python module name to run after installing the packages.", "type": "string" }, "workerType": { "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.", "type": "string" }, "args": { "description": "Optional. Command line arguments to pass to the program.", "items": { "type": "string" }, "type": "array" }, "region": { "description": "Required. The Google Compute Engine region to run the training job in.", "type": "string" }, "parameterServerType": { "type": "string", "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero." }, "scaleTier": { "enum": [ "BASIC", "STANDARD_1", "PREMIUM_1", "BASIC_GPU", "CUSTOM" ], "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.", "type": "string", "enumDescriptions": [ "A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.", "Many workers and a few parameter servers.", "A large number of workers with many parameter servers.", "A single worker instance [with a\nGPU](/ml-engine/docs/how-tos/using-gpus).", "The CUSTOM tier is not a set tier, but rather enables you to use your\nown cluster specification. When you use this tier, set values to\nconfigure your processing cluster according to these guidelines:\n\n* You _must_ set `TrainingInput.masterType` to specify the type\n of machine to use for your master node. This is the only required\n setting.\n\n* You _may_ set `TrainingInput.workerCount` to specify the number of\n workers to use. If you specify one or more workers, you _must_ also\n set `TrainingInput.workerType` to specify the type of machine to use\n for your worker nodes.\n\n* You _may_ set `TrainingInput.parameterServerCount` to specify the\n number of parameter servers to use. If you specify one or more\n parameter servers, you _must_ also set\n `TrainingInput.parameterServerType` to specify the type of machine to\n use for your parameter servers.\n\nNote that all of your workers must use the same machine type, which can\nbe different from your parameter server type and master type. Your\nparameter servers must likewise use the same machine type, which can be\ndifferent from your worker type and master type." ] }, "jobDir": { "description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.", "type": "string" }, "hyperparameters": { "description": "Optional. The set of Hyperparameters to tune.", "$ref": "GoogleCloudMlV1beta1__HyperparameterSpec" }, "parameterServerCount": { "format": "int64", "description": "Optional. The number of parameter server replicas to use for the training\njob. Each replica in the cluster will be of the type specified in\n`parameter_server_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parameter_server_type`.", "type": "string" }, "packageUris": { "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.\nThe maximum number of package URIs is 100.", "items": { "type": "string" }, "type": "array" }, "workerCount": { "format": "int64", "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.", "type": "string" }, "masterType": { "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n GPU that you can use in your trainer\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four GPUs.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.", "type": "string" }, "runtimeVersion": { "description": "Optional. The Google Cloud ML runtime version to use for training. If not\nset, Google Cloud ML will choose the latest stable version.", "type": "string" } }, "id": "GoogleCloudMlV1beta1__TrainingInput" }, "GoogleLongrunning__ListOperationsResponse": { "type": "object", "properties": { "operations": { "items": { "$ref": "GoogleLongrunning__Operation" }, "type": "array", "description": "A list of operations that matches the specified filter in the request." }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "id": "GoogleLongrunning__ListOperationsResponse", "description": "The response message for Operations.ListOperations." }, "GoogleIamV1__Condition": { "description": "A condition to be met.", "type": "object", "properties": { "op": { "description": "An operator to apply the subject with.", "type": "string", "enumDescriptions": [ "Default no-op.", "DEPRECATED. Use IN instead.", "DEPRECATED. Use NOT_IN instead.", "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.", "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.", "Subject is discharged" ], "enum": [ "NO_OP", "EQUALS", "NOT_EQUALS", "IN", "NOT_IN", "DISCHARGED" ] }, "svc": { "type": "string", "description": "Trusted attributes discharged by the service." }, "value": { "description": "DEPRECATED. Use 'values' instead.", "type": "string" }, "sys": { "enumDescriptions": [ "Default non-attribute type", "Region of the resource", "Service name", "Resource name", "IP address of the caller" ], "enum": [ "NO_ATTR", "REGION", "SERVICE", "NAME", "IP" ], "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.", "type": "string" }, "iam": { "type": "string", "enumDescriptions": [ "Default non-attribute.", "Either principal or (if present) authority selector.", "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.", "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).", "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported." ], "enum": [ "NO_ATTR", "AUTHORITY", "ATTRIBUTION", "APPROVER", "JUSTIFICATION_TYPE" ], "description": "Trusted attributes supplied by the IAM system." }, "values": { "items": { "type": "string" }, "type": "array", "description": "The objects of the condition. This is mutually exclusive with 'value'." } }, "id": "GoogleIamV1__Condition" }, "GoogleCloudMlV1beta1__GetConfigResponse": { "description": "Returns service account information associated with a project.", "type": "object", "properties": { "serviceAccountProject": { "format": "int64", "description": "The project number for `service_account`.", "type": "string" }, "serviceAccount": { "description": "The service account Cloud ML uses to access resources in the project.", "type": "string" } }, "id": "GoogleCloudMlV1beta1__GetConfigResponse" }, "GoogleCloudMlV1beta1__SetDefaultVersionRequest": { "description": "Request message for the SetDefaultVersion request.", "type": "object", "properties": {}, "id": "GoogleCloudMlV1beta1__SetDefaultVersionRequest" }, "GoogleCloudMlV1__ManualScaling": { "description": "Options for manually scaling a model.", "type": "object", "properties": { "nodes": { "format": "int32", "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle plus the cost for each prediction performed.", "type": "integer" } }, "id": "GoogleCloudMlV1__ManualScaling" }, "GoogleIamV1__Binding": { "description": "Associates `members` with a `role`.", "type": "object", "properties": { "condition": { "$ref": "GoogleType__Expr", "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", "items": { "type": "string" }, "type": "array" }, "role": { "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", "type": "string" } }, "id": "GoogleIamV1__Binding" }, "GoogleIamV1__Rule": { "description": "A rule to be applied in a Policy.", "type": "object", "properties": { "in": { "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.", "items": { "type": "string" }, "type": "array" }, "permissions": { "items": { "type": "string" }, "type": "array", "description": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs." }, "action": { "type": "string", "enumDescriptions": [ "Default no action.", "Matching 'Entries' grant access.", "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.", "Matching 'Entries' deny access.", "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.", "Matching 'Entries' tell IAM.Check callers to generate logs." ], "enum": [ "NO_ACTION", "ALLOW", "ALLOW_WITH_LOG", "DENY", "DENY_WITH_LOG", "LOG" ], "description": "Required" }, "notIn": { "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Human-readable description of the rule.", "type": "string" }, "conditions": { "description": "Additional restrictions that must be met", "items": { "$ref": "GoogleIamV1__Condition" }, "type": "array" }, "logConfig": { "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.", "items": { "$ref": "GoogleIamV1__LogConfig" }, "type": "array" } }, "id": "GoogleIamV1__Rule" }, "GoogleCloudMlV1beta1__AutoScaling": { "properties": { "minNodes": { "type": "integer", "format": "int32", "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes." } }, "id": "GoogleCloudMlV1beta1__AutoScaling", "description": "Options for automatically scaling a model.", "type": "object" }, "GoogleIamV1_LogConfig_CounterOptions": { "description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1", "type": "object", "properties": { "field": { "description": "The field value to attribute.", "type": "string" }, "metric": { "description": "The metric to update.", "type": "string" } }, "id": "GoogleIamV1_LogConfig_CounterOptions" }, "GoogleCloudMlV1beta1__ParameterSpec": { "description": "Represents a single hyperparameter to optimize.", "type": "object", "properties": { "minValue": { "format": "double", "description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.", "type": "number" }, "discreteValues": { "description": "Required if type is `DISCRETE`.\nA list of feasible points.\nThe list should be in strictly increasing order. For instance, this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nshould not contain more than 1,000 values.", "items": { "format": "double", "type": "number" }, "type": "array" }, "scaleType": { "description": "Optional. How the parameter should be scaled to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scaling is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_SCALE`).", "type": "string", "enumDescriptions": [ "By default, no scaling is applied.", "Scales the feasible space to (0, 1) linearly.", "Scales the feasible space logarithmically to (0, 1). The entire feasible\nspace must be strictly positive.", "Scales the feasible space \"reverse\" logarithmically to (0, 1). The result\nis that values close to the top of the feasible space are spread out more\nthan points near the bottom. The entire feasible space must be strictly\npositive." ], "enum": [ "NONE", "UNIT_LINEAR_SCALE", "UNIT_LOG_SCALE", "UNIT_REVERSE_LOG_SCALE" ] }, "maxValue": { "format": "double", "description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`.", "type": "number" }, "type": { "enum": [ "PARAMETER_TYPE_UNSPECIFIED", "DOUBLE", "INTEGER", "CATEGORICAL", "DISCRETE" ], "description": "Required. The type of the parameter.", "type": "string", "enumDescriptions": [ "You must specify a valid type. Using this unspecified type will result in\nan error.", "Type for real-valued parameters.", "Type for integral parameters.", "The parameter is categorical, with a value chosen from the categories\nfield.", "The parameter is real valued, with a fixed set of feasible points. If\n`type==DISCRETE`, feasible_points must be provided, and\n{`min_value`, `max_value`} will be ignored." ] }, "parameterName": { "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".", "type": "string" }, "categoricalValues": { "description": "Required if type is `CATEGORICAL`. The list of possible categories.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudMlV1beta1__ParameterSpec" }, "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric": { "id": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric", "description": "An observed value of a metric.", "type": "object", "properties": { "trainingStep": { "format": "int64", "description": "The global training step for this metric.", "type": "string" }, "objectiveValue": { "format": "double", "description": "The objective value at this training step.", "type": "number" } } }, "GoogleCloudMlV1beta1__PredictionOutput": { "type": "object", "properties": { "errorCount": { "format": "int64", "description": "The number of data instances which resulted in errors.", "type": "string" }, "nodeHours": { "format": "double", "description": "Node hours used by the batch prediction job.", "type": "number" }, "outputPath": { "description": "The output Google Cloud Storage location provided at the job creation time.", "type": "string" }, "predictionCount": { "type": "string", "format": "int64", "description": "The number of generated predictions." } }, "id": "GoogleCloudMlV1beta1__PredictionOutput", "description": "Represents results of a prediction job." }, "GoogleCloudMlV1beta1__TrainingOutput": { "description": "Represents results of a training job. Output only.", "type": "object", "properties": { "completedTrialCount": { "format": "int64", "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.", "type": "string" }, "isHyperparameterTuningJob": { "description": "Whether this job is a hyperparameter tuning job.", "type": "boolean" }, "consumedMLUnits": { "format": "double", "description": "The amount of ML units consumed by the job.", "type": "number" }, "trials": { "items": { "$ref": "GoogleCloudMlV1beta1__HyperparameterOutput" }, "type": "array", "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs." } }, "id": "GoogleCloudMlV1beta1__TrainingOutput" }, "GoogleIamV1_LogConfig_CloudAuditOptions": { "description": "Write a Cloud Audit log", "type": "object", "properties": { "logName": { "enumDescriptions": [ "Default. Should not be used.", "Corresponds to \"cloudaudit.googleapis.com/activity\"", "Corresponds to \"cloudaudit.googleapis.com/data_access\"" ], "enum": [ "UNSPECIFIED_LOG_NAME", "ADMIN_ACTIVITY", "DATA_ACCESS" ], "description": "The log_name to populate in the Cloud Audit Record.", "type": "string" } }, "id": "GoogleIamV1_LogConfig_CloudAuditOptions" }, "GoogleCloudMlV1__Version": { "description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).\n\nNext ID: 18", "type": "object", "properties": { "isDefault": { "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).", "type": "boolean" }, "autoScaling": { "$ref": "GoogleCloudMlV1__AutoScaling", "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the version was created." }, "manualScaling": { "$ref": "GoogleCloudMlV1__ManualScaling", "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes." }, "state": { "enum": [ "UNKNOWN", "READY", "CREATING", "FAILED" ], "description": "Output only. The state of a version.", "type": "string", "enumDescriptions": [ "The version state is unspecified.", "The version is ready for prediction.", "The version is still in the process of creation.", "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure." ] }, "name": { "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.", "type": "string" }, "errorMessage": { "description": "Output only. The details of a failure or a cancellation.", "type": "string" }, "lastUseTime": { "format": "google-datetime", "description": "Output only. The time the version was last used for prediction.", "type": "string" }, "runtimeVersion": { "type": "string", "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version." }, "description": { "description": "Optional. The description specified for the version when it was created.", "type": "string" }, "deploymentUri": { "type": "string", "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformation.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000." } }, "id": "GoogleCloudMlV1__Version" }, "GoogleIamV1_LogConfig_DataAccessOptions": { "properties": { "logMode": { "enum": [ "LOG_MODE_UNSPECIFIED", "LOG_FAIL_CLOSED" ], "description": "Whether Gin logging should happen in a fail-closed manner at the caller.\nThis is relevant only in the LocalIAM implementation, for now.", "type": "string", "enumDescriptions": [ "Client is not required to write a partial Gin log immediately after\nthe authorization check. If client chooses to write one and it fails,\nclient may either fail open (allow the operation to continue) or\nfail closed (handle as a DENY outcome).", "The application's operation in the context of which this authorization\ncheck is being made may only be performed if it is successfully logged\nto Gin. For instance, the authorization library may satisfy this\nobligation by emitting a partial log entry at authorization check time\nand only returning ALLOW to the application if it succeeds.\n\nIf a matching Rule has this directive, but the client has not indicated\nthat it will honor such requirements, then the IAM check will result in\nauthorization failure by setting CheckPolicyResponse.success=false." ] } }, "id": "GoogleIamV1_LogConfig_DataAccessOptions", "description": "Write a Data Access (Gin) log", "type": "object" }, "GoogleCloudMlV1beta1__HyperparameterSpec": { "description": "Represents a set of hyperparameters to optimize.", "type": "object", "properties": { "maxParallelTrials": { "format": "int32", "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.", "type": "integer" }, "hyperparameterMetricTag": { "description": "Optional. The Tensorflow summary tag name to use for optimizing trials. For\ncurrent versions of Tensorflow, this tag name should exactly match what is\nshown in Tensorboard, including all scopes. For versions of Tensorflow\nprior to 0.12, this should be only the tag passed to tf.Summary.\nBy default, \"training/hptuning/metric\" will be used.", "type": "string" }, "goal": { "description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.", "type": "string", "enumDescriptions": [ "Goal Type will default to maximize.", "Maximize the goal metric.", "Minimize the goal metric." ], "enum": [ "GOAL_TYPE_UNSPECIFIED", "MAXIMIZE", "MINIMIZE" ] }, "maxTrials": { "format": "int32", "description": "Optional. How many training trials should be attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.", "type": "integer" }, "params": { "description": "Required. The set of parameters to tune.", "items": { "$ref": "GoogleCloudMlV1beta1__ParameterSpec" }, "type": "array" } }, "id": "GoogleCloudMlV1beta1__HyperparameterSpec" }, "GoogleCloudMlV1__OperationMetadata": { "type": "object", "properties": { "modelName": { "description": "Contains the name of the model associated with the operation.", "type": "string" }, "version": { "$ref": "GoogleCloudMlV1__Version", "description": "Contains the version associated with the operation." }, "endTime": { "format": "google-datetime", "description": "The time operation processing completed.", "type": "string" }, "operationType": { "description": "The operation type.", "type": "string", "enumDescriptions": [ "Unspecified operation type.", "An operation to create a new version.", "An operation to delete an existing version.", "An operation to delete an existing model." ], "enum": [ "OPERATION_TYPE_UNSPECIFIED", "CREATE_VERSION", "DELETE_VERSION", "DELETE_MODEL" ] }, "startTime": { "format": "google-datetime", "description": "The time operation processing started.", "type": "string" }, "isCancellationRequested": { "description": "Indicates whether a request to cancel this operation has been made.", "type": "boolean" }, "createTime": { "format": "google-datetime", "description": "The time the operation was submitted.", "type": "string" } }, "id": "GoogleCloudMlV1__OperationMetadata", "description": "Represents the metadata of the long-running operation.\n\nNext ID: 9" }, "GoogleCloudMlV1beta1__OperationMetadata": { "properties": { "isCancellationRequested": { "description": "Indicates whether a request to cancel this operation has been made.", "type": "boolean" }, "createTime": { "format": "google-datetime", "description": "The time the operation was submitted.", "type": "string" }, "modelName": { "description": "Contains the name of the model associated with the operation.", "type": "string" }, "version": { "description": "Contains the version associated with the operation.", "$ref": "GoogleCloudMlV1beta1__Version" }, "endTime": { "format": "google-datetime", "description": "The time operation processing completed.", "type": "string" }, "operationType": { "enumDescriptions": [ "Unspecified operation type.", "An operation to create a new version.", "An operation to delete an existing version.", "An operation to delete an existing model." ], "enum": [ "OPERATION_TYPE_UNSPECIFIED", "CREATE_VERSION", "DELETE_VERSION", "DELETE_MODEL" ], "description": "The operation type.", "type": "string" }, "startTime": { "format": "google-datetime", "description": "The time operation processing started.", "type": "string" } }, "id": "GoogleCloudMlV1beta1__OperationMetadata", "description": "Represents the metadata of the long-running operation.\n\nNext ID: 9", "type": "object" }, "GoogleIamV1__AuditLogConfig": { "type": "object", "properties": { "logType": { "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "description": "The log type that this config enables.", "type": "string" }, "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleIamV1__AuditLogConfig", "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging." }, "GoogleType__Expr": { "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", "type": "object", "properties": { "description": { "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", "type": "string" }, "location": { "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", "type": "string" } }, "id": "GoogleType__Expr" }, "GoogleCloudMlV1beta1__ListModelsResponse": { "description": "Response message for the ListModels method.", "type": "object", "properties": { "nextPageToken": { "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.", "type": "string" }, "models": { "description": "The list of models.", "items": { "$ref": "GoogleCloudMlV1beta1__Model" }, "type": "array" } }, "id": "GoogleCloudMlV1beta1__ListModelsResponse" }, "GoogleLongrunning__Operation": { "type": "object", "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.", "type": "boolean" }, "response": { "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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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 have the format of `operations/some/unique/name`.", "type": "string" }, "error": { "$ref": "GoogleRpc__Status", "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "type": "object", "additionalProperties": { "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." } }, "id": "GoogleLongrunning__Operation", "description": "This resource represents a long-running operation that is the result of a\nnetwork API call." }, "GoogleIamV1__AuditConfig": { "properties": { "service": { "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", "type": "string" }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.\nNext ID: 4", "items": { "$ref": "GoogleIamV1__AuditLogConfig" }, "type": "array" }, "exemptedMembers": { "items": { "type": "string" }, "type": "array" } }, "id": "GoogleIamV1__AuditConfig", "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", "type": "object" }, "GoogleCloudMlV1beta1__HyperparameterOutput": { "description": "Represents the result of a single hyperparameter tuning trial from a\ntraining job. The TrainingOutput object that is returned on successful\ncompletion of a training job with hyperparameter tuning includes a list\nof HyperparameterOutput objects, one for each successful trial.", "type": "object", "properties": { "hyperparameters": { "additionalProperties": { "type": "string" }, "description": "The hyperparameters given to this trial.", "type": "object" }, "trialId": { "description": "The trial id for these results.", "type": "string" }, "allMetrics": { "items": { "$ref": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric" }, "type": "array", "description": "All recorded object metrics for this trial." }, "finalMetric": { "description": "The final objective metric seen for this trial.", "$ref": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric" } }, "id": "GoogleCloudMlV1beta1__HyperparameterOutput" }, "GoogleProtobuf__Empty": { "type": "object", "properties": {}, "id": "GoogleProtobuf__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 `{}`." } }, "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "canonicalName": "Cloud Machine Learning Engine", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" } } } }, "rootUrl": "https://ml.googleapis.com/", "ownerDomain": "google.com", "name": "ml", "batchPath": "batch", "title": "Google Cloud Machine Learning Engine", "ownerName": "Google", "resources": { "projects": { "methods": { "getConfig": { "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudMlV1beta1__GetConfigResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The project name.", "type": "string", "required": true, "pattern": "^projects/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}:getConfig", "path": "v1beta1/{+name}:getConfig", "id": "ml.projects.getConfig" }, "predict": { "httpMethod": "POST", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleApi__HttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource.", "type": "string", "required": true, "pattern": "^projects/.+$", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}:predict", "path": "v1beta1/{+name}:predict", "id": "ml.projects.predict", "request": { "$ref": "GoogleCloudMlV1beta1__PredictRequest" }, "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION" } }, "resources": { "models": { "methods": { "delete": { "path": "v1beta1/{+name}", "id": "ml.projects.models.delete", "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1beta1/projects.models.versions/delete).", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunning__Operation" }, "parameters": { "name": { "location": "path", "description": "Required. The name of the model.", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudMlV1beta1__ListModelsResponse" }, "parameters": { "parent": { "description": "Required. The name of the project whose models are to be listed.", "type": "string", "required": true, "pattern": "^projects/[^/]+$", "location": "path" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call." }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/models", "path": "v1beta1/{+parent}/models", "id": "ml.projects.models.list", "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions." }, "create": { "request": { "$ref": "GoogleCloudMlV1beta1__Model" }, "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1beta1/projects.models.versions/create).", "response": { "$ref": "GoogleCloudMlV1beta1__Model" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "description": "Required. The project name.", "type": "string", "required": true, "pattern": "^projects/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/models", "id": "ml.projects.models.create", "path": "v1beta1/{+parent}/models" }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "request": { "$ref": "GoogleIamV1__SetIamPolicyRequest" }, "response": { "$ref": "GoogleIamV1__Policy" }, "parameterOrder": [ "resource" ], "httpMethod": "POST", "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}:setIamPolicy", "id": "ml.projects.models.setIamPolicy", "path": "v1beta1/{+resource}:setIamPolicy" }, "getIamPolicy": { "path": "v1beta1/{+resource}:getIamPolicy", "id": "ml.projects.models.getIamPolicy", "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", "httpMethod": "GET", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1__Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}:getIamPolicy" }, "get": { "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudMlV1beta1__Model" }, "parameters": { "name": { "description": "Required. The name of the model.", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}", "path": "v1beta1/{+name}", "id": "ml.projects.models.get" }, "testIamPermissions": { "request": { "$ref": "GoogleIamV1__TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "response": { "$ref": "GoogleIamV1__TestIamPermissionsResponse" }, "parameterOrder": [ "resource" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}:testIamPermissions", "id": "ml.projects.models.testIamPermissions", "path": "v1beta1/{+resource}:testIamPermissions" } }, "resources": { "versions": { "methods": { "get": { "path": "v1beta1/{+name}", "id": "ml.projects.models.versions.get", "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudMlV1beta1__Version" }, "parameters": { "name": { "location": "path", "description": "Required. The name of the version.", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}" }, "list": { "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has a lot of versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages):", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudMlV1beta1__ListVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/models/[^/]+$", "location": "path", "description": "Required. The name of the model for which to list the version.", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions", "path": "v1beta1/{+parent}/versions", "id": "ml.projects.models.versions.list" }, "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunning__Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/models/[^/]+$", "location": "path", "description": "Required. The name of the model.", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions", "path": "v1beta1/{+parent}/versions", "id": "ml.projects.models.versions.create", "request": { "$ref": "GoogleCloudMlV1beta1__Version" }, "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault)." }, "setDefault": { "parameters": { "name": { "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault", "id": "ml.projects.models.versions.setDefault", "path": "v1beta1/{+name}:setDefault", "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.", "request": { "$ref": "GoogleCloudMlV1beta1__SetDefaultVersionRequest" }, "response": { "$ref": "GoogleCloudMlV1beta1__Version" }, "parameterOrder": [ "name" ], "httpMethod": "POST" }, "delete": { "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.", "response": { "$ref": "GoogleLongrunning__Operation" }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).", "type": "string", "required": true, "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}", "id": "ml.projects.models.versions.delete", "path": "v1beta1/{+name}" } } } } }, "operations": { "methods": { "cancel": { "response": { "$ref": "GoogleProtobuf__Empty" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true, "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel", "id": "ml.projects.operations.cancel", "path": "v1beta1/{+name}: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`." }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobuf__Empty" }, "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "required": true, "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "id": "ml.projects.operations.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`." }, "get": { "response": { "$ref": "GoogleLongrunning__Operation" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", "id": "ml.projects.operations.get", "path": "v1beta1/{+name}", "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." }, "list": { "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunning__ListOperationsResponse" }, "parameters": { "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "description": "The name of the operation's parent resource.", "type": "string", "required": true, "pattern": "^projects/[^/]+$", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/operations", "path": "v1beta1/{+name}/operations", "id": "ml.projects.operations.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." } } }, "jobs": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudMlV1beta1__Job" }, "parameters": { "name": { "location": "path", "description": "Required. The name of the job to get the description of.", "type": "string", "required": true, "pattern": "^projects/[^/]+/jobs/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}", "path": "v1beta1/{+name}", "id": "ml.projects.jobs.get", "description": "Describes a job." }, "list": { "response": { "$ref": "GoogleCloudMlV1beta1__ListJobsResponse" }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+$", "location": "path", "description": "Required. The name of the project for which to list jobs.", "type": "string", "required": true }, "filter": { "description": "Optional. Specifies the subset of jobs to retrieve.", "type": "string", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/jobs", "id": "ml.projects.jobs.list", "path": "v1beta1/{+parent}/jobs", "description": "Lists the jobs in the project." }, "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudMlV1beta1__Job" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+$", "location": "path", "description": "Required. The project name.", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/jobs", "path": "v1beta1/{+parent}/jobs", "id": "ml.projects.jobs.create", "request": { "$ref": "GoogleCloudMlV1beta1__Job" }, "description": "Creates a training or a batch prediction job." }, "cancel": { "request": { "$ref": "GoogleCloudMlV1beta1__CancelJobRequest" }, "description": "Cancels a running job.", "response": { "$ref": "GoogleProtobuf__Empty" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the job to cancel.", "type": "string", "required": true, "pattern": "^projects/[^/]+/jobs/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}:cancel", "id": "ml.projects.jobs.cancel", "path": "v1beta1/{+name}:cancel" } } } } } }, "parameters": { "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "key": { "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string" }, "quotaUser": { "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string" }, "pp": { "location": "query", "description": "Pretty-print response.", "default": "true", "type": "boolean" }, "bearer_token": { "description": "OAuth bearer token.", "type": "string", "location": "query" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", "type": "string" }, "alt": { "enum": [ "json", "media", "proto" ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "description": "Data format for response.", "default": "json" } }, "version": "v1beta1", "baseUrl": "https://ml.googleapis.com/", "servicePath": "", "description": "An API to enable creating and using machine learning models.", "kind": "discovery#restDescription" }