Google Git
Sign in
fuchsia / third_party / github.com / googleapis / google-api-go-client / refs/tags/v0.40.0 / . / notebooks / v1 / notebooks-api.json
blob: f20636a202a1374772ba4d031cb38b958f1eb1d8 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://notebooks.googleapis.com/",
"batchPath": "batch",
"canonicalName": "AI Platform Notebooks",
"description": "AI Platform Notebooks API is used to manage notebook resources in Google Cloud.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/ai-platform/notebooks/docs/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "notebooks:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://notebooks.mtls.googleapis.com/",
"name": "notebooks",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"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",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "notebooks.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "notebooks.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"environments": {
"methods": {
"create": {
"description": "Creates a new Environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments",
"httpMethod": "POST",
"id": "notebooks.projects.locations.environments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"environmentId": {
"description": "Required. User-defined unique ID of this environment. The `environment_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/environments",
"request": {
"$ref": "Environment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a single Environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
"httpMethod": "DELETE",
"id": "notebooks.projects.locations.environments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of a single Environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
"httpMethod": "GET",
"id": "notebooks.projects.locations.environments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Environment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists environments in a project.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments",
"httpMethod": "GET",
"id": "notebooks.projects.locations.environments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum return size of the list call.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previous returned page token that can be used to continue listing from the last result.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/environments",
"response": {
"$ref": "ListEnvironmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"executions": {
"methods": {
"create": {
"description": "Creates a new Scheduled Notebook in a given project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/executions",
"httpMethod": "POST",
"id": "notebooks.projects.locations.executions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"executionId": {
"description": "Required. User-defined unique ID of this execution.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/executions",
"request": {
"$ref": "Execution"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes execution",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/executions/{executionsId}",
"httpMethod": "DELETE",
"id": "notebooks.projects.locations.executions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/executions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of executions",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/executions/{executionsId}",
"httpMethod": "GET",
"id": "notebooks.projects.locations.executions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/schedules/{execution_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/executions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Execution"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists executions in a given project and location",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/executions",
"httpMethod": "GET",
"id": "notebooks.projects.locations.executions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Filter applied to resulting executions.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Sort by field.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum return size of the list call.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previous returned page token that can be used to continue listing from the last result.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/executions",
"response": {
"$ref": "ListExecutionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"instances": {
"methods": {
"create": {
"description": "Creates a new Instance in a given project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.create",
"parameterOrder": [
"parent"
],
"parameters": {
"instanceId": {
"description": "Required. User-defined unique ID of this instance.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/instances",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a single Instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"httpMethod": "DELETE",
"id": "notebooks.projects.locations.instances.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of a single Instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"httpMethod": "GET",
"id": "notebooks.projects.locations.instances.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Instance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy",
"httpMethod": "GET",
"id": "notebooks.projects.locations.instances.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getInstanceHealth": {
"description": "Check if a notebook instance is healthy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getInstanceHealth",
"httpMethod": "GET",
"id": "notebooks.projects.locations.instances.getInstanceHealth",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:getInstanceHealth",
"response": {
"$ref": "GetInstanceHealthResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"isUpgradeable": {
"description": "Check if a notebook instance is upgradable.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:isUpgradeable",
"httpMethod": "GET",
"id": "notebooks.projects.locations.instances.isUpgradeable",
"parameterOrder": [
"notebookInstance"
],
"parameters": {
"notebookInstance": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+notebookInstance}:isUpgradeable",
"response": {
"$ref": "IsInstanceUpgradeableResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists instances in a given project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances",
"httpMethod": "GET",
"id": "notebooks.projects.locations.instances.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum return size of the list call.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previous returned page token that can be used to continue listing from the last result.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/instances",
"response": {
"$ref": "ListInstancesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"register": {
"description": "Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances:register",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.register",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/instances:register",
"request": {
"$ref": "RegisterInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"report": {
"description": "Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:report",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.report",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:report",
"request": {
"$ref": "ReportInstanceInfoRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"reset": {
"description": "Resets a notebook instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.reset",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:reset",
"request": {
"$ref": "ResetInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setAccelerator": {
"description": "Updates the guest accelerators of a single Instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setAccelerator",
"httpMethod": "PATCH",
"id": "notebooks.projects.locations.instances.setAccelerator",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setAccelerator",
"request": {
"$ref": "SetInstanceAcceleratorRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setLabels": {
"description": "Replaces all the labels of an Instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setLabels",
"httpMethod": "PATCH",
"id": "notebooks.projects.locations.instances.setLabels",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setLabels",
"request": {
"$ref": "SetInstanceLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setMachineType": {
"description": "Updates the machine type of a single Instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setMachineType",
"httpMethod": "PATCH",
"id": "notebooks.projects.locations.instances.setMachineType",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setMachineType",
"request": {
"$ref": "SetInstanceMachineTypeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"start": {
"description": "Starts a notebook instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:start",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.start",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:start",
"request": {
"$ref": "StartInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"stop": {
"description": "Stops a notebook instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:stop",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.stop",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:stop",
"request": {
"$ref": "StopInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"upgrade": {
"description": "Upgrades a notebook instance to the latest version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.upgrade",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:upgrade",
"request": {
"$ref": "UpgradeInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"upgradeInternal": {
"description": "Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgradeInternal",
"httpMethod": "POST",
"id": "notebooks.projects.locations.instances.upgradeInternal",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:upgradeInternal",
"request": {
"$ref": "UpgradeInstanceInternalRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"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/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "notebooks.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "notebooks.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "notebooks.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "notebooks.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"schedules": {
"methods": {
"create": {
"description": "Creates a new Scheduled Notebook in a given project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules",
"httpMethod": "POST",
"id": "notebooks.projects.locations.schedules.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"scheduleId": {
"description": "Required. User-defined unique ID of this schedule.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/schedules",
"request": {
"$ref": "Schedule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes schedule and all underlying jobs",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
"httpMethod": "DELETE",
"id": "notebooks.projects.locations.schedules.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of schedule",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
"httpMethod": "GET",
"id": "notebooks.projects.locations.schedules.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Schedule"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists schedules in a given project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules",
"httpMethod": "GET",
"id": "notebooks.projects.locations.schedules.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Filter applied to resulting schedules.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field to order results by.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum return size of the list call.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previous returned page token that can be used to continue listing from the last result.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/schedules",
"response": {
"$ref": "ListSchedulesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"trigger": {
"description": "Triggers execution of an existing schedule.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:trigger",
"httpMethod": "POST",
"id": "notebooks.projects.locations.schedules.trigger",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:trigger",
"request": {
"$ref": "TriggerScheduleRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20210122",
"rootUrl": "https://notebooks.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
"description": "Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.",
"id": "AcceleratorConfig",
"properties": {
"coreCount": {
"description": "Count of cores of this accelerator.",
"format": "int64",
"type": "string"
},
"type": {
"description": "Type of this accelerator.",
"enum": [
"ACCELERATOR_TYPE_UNSPECIFIED",
"NVIDIA_TESLA_K80",
"NVIDIA_TESLA_P100",
"NVIDIA_TESLA_V100",
"NVIDIA_TESLA_P4",
"NVIDIA_TESLA_T4",
"NVIDIA_TESLA_A100",
"NVIDIA_TESLA_T4_VWS",
"NVIDIA_TESLA_P100_VWS",
"NVIDIA_TESLA_P4_VWS",
"TPU_V2",
"TPU_V3"
],
"enumDescriptions": [
"Accelerator type is not specified.",
"Accelerator type is Nvidia Tesla K80.",
"Accelerator type is Nvidia Tesla P100.",
"Accelerator type is Nvidia Tesla V100.",
"Accelerator type is Nvidia Tesla P4.",
"Accelerator type is Nvidia Tesla T4.",
"Accelerator type is Nvidia Tesla A100.",
"Accelerator type is NVIDIA Tesla T4 Virtual Workstations.",
"Accelerator type is NVIDIA Tesla P100 Virtual Workstations.",
"Accelerator type is NVIDIA Tesla P4 Virtual Workstations.",
"(Coming soon) Accelerator type is TPU V2.",
"(Coming soon) Accelerator type is TPU V3."
],
"type": "string"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"ContainerImage": {
"description": "Definition of a container image for starting a notebook instance with the environment installed in a container.",
"id": "ContainerImage",
"properties": {
"repository": {
"description": "Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`",
"type": "string"
},
"tag": {
"description": "The tag of the container image. If not specified, this defaults to the latest tag.",
"type": "string"
}
},
"type": "object"
},
"Disk": {
"description": "An instance-attached disk resource.",
"id": "Disk",
"properties": {
"autoDelete": {
"description": "Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
"type": "boolean"
},
"boot": {
"description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.",
"type": "boolean"
},
"deviceName": {
"description": "Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.",
"type": "string"
},
"diskSizeGb": {
"description": "Indicates the size of the disk in base-2 GB.",
"format": "int64",
"type": "string"
},
"guestOsFeatures": {
"description": "Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"index": {
"description": "A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.",
"format": "int64",
"type": "string"
},
"interface": {
"description": "Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: NVME SCSI",
"type": "string"
},
"kind": {
"description": "Type of the resource. Always compute#attachedDisk for attached disks.",
"type": "string"
},
"licenses": {
"description": "A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.",
"items": {
"type": "string"
},
"type": "array"
},
"mode": {
"description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: READ_ONLY READ_WRITE",
"type": "string"
},
"source": {
"description": "Indicates a valid partial or full URL to an existing Persistent Disk resource.",
"type": "string"
},
"type": {
"description": "Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"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"
},
"Environment": {
"description": "Definition of a software environment that is used to start a notebook instance.",
"id": "Environment",
"properties": {
"containerImage": {
"$ref": "ContainerImage",
"description": "Use a container image to start the notebook instance."
},
"createTime": {
"description": "Output only. The time at which this environment was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "A brief description of this environment.",
"type": "string"
},
"displayName": {
"description": "Display name of this environment for the UI.",
"type": "string"
},
"name": {
"description": "Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`",
"readOnly": true,
"type": "string"
},
"postStartupScript": {
"description": "Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `\"gs://path-to-file/file-name\"`",
"type": "string"
},
"vmImage": {
"$ref": "VmImage",
"description": "Use a Compute Engine VM image to start the notebook instance."
}
},
"type": "object"
},
"Execution": {
"description": "The definition of a single executed notebook.",
"id": "Execution",
"properties": {
"createTime": {
"description": "Output only. Time the Execution was instantiated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "A brief description of this execution.",
"type": "string"
},
"displayName": {
"description": "Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.",
"readOnly": true,
"type": "string"
},
"executionTemplate": {
"$ref": "ExecutionTemplate",
"description": "execute metadata including name, hardware spec, region, labels, etc."
},
"name": {
"description": "Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}",
"readOnly": true,
"type": "string"
},
"outputNotebookFile": {
"description": "Output notebook file generated by this execution",
"type": "string"
},
"state": {
"description": "Output only. State of the underlying AI Platform job.",
"enum": [
"STATE_UNSPECIFIED",
"QUEUED",
"PREPARING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLING",
"CANCELLED"
],
"enumDescriptions": [
"The job state is unspecified.",
"The job has been just created and processing has not yet begun.",
"The service is preparing to execution the job.",
"The job is in progress.",
"The job completed successfully.",
"The job failed. `error_message` should contain the details of the failure.",
"The job is being cancelled. `error_message` should describe the reason for the cancellation.",
"The job has been cancelled. `error_message` should describe the reason for the cancellation."
],
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. Time the Execution was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ExecutionTemplate": {
"description": "The description a notebook execution workload.",
"id": "ExecutionTemplate",
"properties": {
"acceleratorConfig": {
"$ref": "SchedulerAcceleratorConfig",
"description": "Configuration (count and accelerator type) for hardware running notebook execution."
},
"containerImageUri": {
"description": "Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container",
"type": "string"
},
"inputNotebookFile": {
"description": "Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.",
"type": "object"
},
"masterType": {
"description": "Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.",
"type": "string"
},
"outputNotebookFolder": {
"description": "Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks",
"type": "string"
},
"paramsYamlFile": {
"description": "Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml",
"type": "string"
},
"scaleTier": {
"description": "Required. Scale tier of the hardware used for notebook execution.",
"enum": [
"SCALE_TIER_UNSPECIFIED",
"BASIC",
"STANDARD_1",
"PREMIUM_1",
"BASIC_GPU",
"BASIC_TPU",
"CUSTOM"
],
"enumDescriptions": [
"Unspecified Scale Tier.",
"A single worker instance. This tier is suitable for learning how to use Cloud 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 K80 GPU.",
"A single worker instance with a Cloud TPU.",
"The CUSTOM tier is not a set tier, but rather enables you to use your own cluster specification. When you use this tier, set values to configure your processing cluster according to these guidelines: * You _must_ set `TrainingInput.masterType` to specify the type of machine to use for your master node. This is the only required setting. * You _may_ set `TrainingInput.workerCount` to specify the number of workers to use. If you specify one or more workers, you _must_ also set `TrainingInput.workerType` to specify the type of machine to use for your worker nodes. * You _may_ set `TrainingInput.parameterServerCount` to specify the number of parameter servers to use. If you specify one or more parameter servers, you _must_ also set `TrainingInput.parameterServerType` to specify the type of machine to use for your parameter servers. Note that all of your workers must use the same machine type, which can be different from your parameter server type and master type. Your parameter servers must likewise use the same machine type, which can be different from your worker type and master type."
],
"type": "string"
}
},
"type": "object"
},
"Expr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' \u0026\u0026 document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
"id": "Expr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language syntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
"type": "string"
}
},
"type": "object"
},
"GetInstanceHealthResponse": {
"description": "Response for checking if a notebook instance is healthy.",
"id": "GetInstanceHealthResponse",
"properties": {
"healthInfo": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. Additional information about instance health. Example: healthInfo\": { \"docker_proxy_agent_status\": \"1\", \"docker_status\": \"1\", \"jupyterlab_api_status\": \"-1\", \"jupyterlab_status\": \"-1\", \"updated\": \"2020-10-18 09:40:03.573409\" }",
"readOnly": true,
"type": "object"
},
"healthState": {
"description": "Output only. Runtime health_state.",
"enum": [
"HEALTH_STATE_UNSPECIFIED",
"HEALTHY",
"UNHEALTHY",
"AGENT_NOT_INSTALLED",
"AGENT_NOT_RUNNING"
],
"enumDescriptions": [
"The instance substate is unknown.",
"The instance is known to be in an healthy state (for example, critical daemons are running) Applies to ACTIVE state.",
"The instance is known to be in an unhealthy state (for example, critical daemons are not running) Applies to ACTIVE state.",
"The instance has not installed health monitoring agent. Applies to ACTIVE state.",
"The instance health monitoring agent is not running. Applies to ACTIVE state."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GuestOsFeature": {
"description": "Guest OS features for boot disk.",
"id": "GuestOsFeature",
"properties": {
"type": {
"description": "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS",
"type": "string"
}
},
"type": "object"
},
"Instance": {
"description": "The definition of a notebook instance.",
"id": "Instance",
"properties": {
"acceleratorConfig": {
"$ref": "AcceleratorConfig",
"description": "The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](/compute/docs/gpus/#gpus-list)."
},
"bootDiskSizeGb": {
"description": "Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.",
"format": "int64",
"type": "string"
},
"bootDiskType": {
"description": "Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).",
"enum": [
"DISK_TYPE_UNSPECIFIED",
"PD_STANDARD",
"PD_SSD",
"PD_BALANCED"
],
"enumDescriptions": [
"Disk type not set.",
"Standard persistent disk type.",
"SSD persistent disk type.",
"Balanced persistent disk type."
],
"type": "string"
},
"containerImage": {
"$ref": "ContainerImage",
"description": "Use a container image to start the notebook instance."
},
"createTime": {
"description": "Output only. Instance creation time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"customGpuDriverPath": {
"description": "Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.",
"type": "string"
},
"dataDiskSizeGb": {
"description": "Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.",
"format": "int64",
"type": "string"
},
"dataDiskType": {
"description": "Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).",
"enum": [
"DISK_TYPE_UNSPECIFIED",
"PD_STANDARD",
"PD_SSD",
"PD_BALANCED"
],
"enumDescriptions": [
"Disk type not set.",
"Standard persistent disk type.",
"SSD persistent disk type.",
"Balanced persistent disk type."
],
"type": "string"
},
"diskEncryption": {
"description": "Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.",
"enum": [
"DISK_ENCRYPTION_UNSPECIFIED",
"GMEK",
"CMEK"
],
"enumDescriptions": [
"Disk encryption is not specified.",
"Use Google managed encryption keys to encrypt the boot disk.",
"Use customer managed encryption keys to encrypt the boot disk."
],
"type": "string"
},
"disks": {
"description": "Output only. Attached disks to notebook instance.",
"items": {
"$ref": "Disk"
},
"readOnly": true,
"type": "array"
},
"installGpuDriver": {
"description": "Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.",
"type": "boolean"
},
"instanceOwners": {
"description": "Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.",
"items": {
"type": "string"
},
"type": "array"
},
"kmsKey": {
"description": "Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about [using your own encryption keys](/kms/docs/quickstart).",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this instance. These can be later modified by the setLabels method.",
"type": "object"
},
"machineType": {
"description": "Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Custom metadata to apply to this instance.",
"type": "object"
},
"name": {
"description": "Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"readOnly": true,
"type": "string"
},
"network": {
"description": "The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`",
"type": "string"
},
"noProxyAccess": {
"description": "If true, the notebook instance will not register with the proxy.",
"type": "boolean"
},
"noPublicIp": {
"description": "If true, no public IP will be assigned to this instance.",
"type": "boolean"
},
"noRemoveDataDisk": {
"description": "Input only. If true, the data disk will not be auto deleted when deleting the instance.",
"type": "boolean"
},
"postStartupScript": {
"description": "Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).",
"type": "string"
},
"proxyUri": {
"description": "Output only. The proxy endpoint that is used to access the Jupyter notebook.",
"readOnly": true,
"type": "string"
},
"serviceAccount": {
"description": "The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.",
"type": "string"
},
"serviceAccountScopes": {
"description": "Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute",
"items": {
"type": "string"
},
"type": "array"
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig",
"description": "Optional. Shielded VM configuration. [Images using supported Shielded VM features] (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm)."
},
"state": {
"description": "Output only. The state of this instance.",
"enum": [
"STATE_UNSPECIFIED",
"STARTING",
"PROVISIONING",
"ACTIVE",
"STOPPING",
"STOPPED",
"DELETED",
"UPGRADING",
"INITIALIZING",
"REGISTERING"
],
"enumDescriptions": [
"State is not specified.",
"The control logic is starting the instance.",
"The control logic is installing required frameworks and registering the instance with notebook proxy",
"The instance is running.",
"The control logic is stopping the instance.",
"The instance is stopped.",
"The instance is deleted.",
"The instance is upgrading.",
"The instance is being created.",
"The instance is getting registered."
],
"readOnly": true,
"type": "string"
},
"subnet": {
"description": "The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`",
"type": "string"
},
"tags": {
"description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).",
"items": {
"type": "string"
},
"type": "array"
},
"updateTime": {
"description": "Output only. Instance update time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"upgradeHistory": {
"description": "The upgrade history of this instance.",
"items": {
"$ref": "UpgradeHistoryEntry"
},
"type": "array"
},
"vmImage": {
"$ref": "VmImage",
"description": "Use a Compute Engine VM image to start the notebook instance."
}
},
"type": "object"
},
"IsInstanceUpgradeableResponse": {
"description": "Response for checking if a notebook instance is upgradeable.",
"id": "IsInstanceUpgradeableResponse",
"properties": {
"upgradeInfo": {
"description": "Additional information about upgrade.",
"type": "string"
},
"upgradeVersion": {
"description": "The version this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true.",
"type": "string"
},
"upgradeable": {
"description": "If an instance is upgradeable.",
"type": "boolean"
}
},
"type": "object"
},
"ListEnvironmentsResponse": {
"description": "Response for listing environments.",
"id": "ListEnvironmentsResponse",
"properties": {
"environments": {
"description": "A list of returned environments.",
"items": {
"$ref": "Environment"
},
"type": "array"
},
"nextPageToken": {
"description": "A page token that can be used to continue listing from the last result in the next list call.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListExecutionsResponse": {
"description": "Response for listing scheduled notebook executions",
"id": "ListExecutionsResponse",
"properties": {
"executions": {
"description": "A list of returned instances.",
"items": {
"$ref": "Execution"
},
"type": "array"
},
"nextPageToken": {
"description": "Page token that can be used to continue listing from the last result in the next list call.",
"type": "string"
},
"unreachable": {
"description": "Executions IDs that could not be reached. For example, ['projects/{project_id}/location/{location}/executions/imagenet_test1', 'projects/{project_id}/location/{location}/executions/classifier_train1'].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListInstancesResponse": {
"description": "Response for listing notebook instances.",
"id": "ListInstancesResponse",
"properties": {
"instances": {
"description": "A list of returned instances.",
"items": {
"$ref": "Instance"
},
"type": "array"
},
"nextPageToken": {
"description": "Page token that can be used to continue listing from the last result in the next list call.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables,",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"ListSchedulesResponse": {
"description": "Response for listing scheduled notebook job.",
"id": "ListSchedulesResponse",
"properties": {
"nextPageToken": {
"description": "Page token that can be used to continue listing from the last result in the next list call.",
"type": "string"
},
"schedules": {
"description": "A list of returned instances.",
"items": {
"$ref": "Schedule"
},
"type": "array"
},
"unreachable": {
"description": "Schedules that could not be reached. For example, ['projects/{project_id}/location/{location}/schedules/monthly_digest', 'projects/{project_id}/location/{location}/schedules/weekly_sentiment'].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"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. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "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 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": {
"additionalProperties": {
"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 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"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OperationMetadata",
"properties": {
"apiVersion": {
"description": "API version used to start the operation.",
"type": "string"
},
"createTime": {
"description": "The time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "The time the operation finished running.",
"format": "google-datetime",
"type": "string"
},
"endpoint": {
"description": "API endpoint name of this operation.",
"type": "string"
},
"requestedCancellation": {
"description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"type": "boolean"
},
"statusMessage": {
"description": "Human-readable status of the operation, if any.",
"type": "string"
},
"target": {
"description": "Server-defined resource path for the target of the operation.",
"type": "string"
},
"verb": {
"description": "Name of the verb executed by the operation.",
"type": "string"
}
},
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RegisterInstanceRequest": {
"description": "Request for registering a notebook instance.",
"id": "RegisterInstanceRequest",
"properties": {
"instanceId": {
"description": "Required. User defined unique ID of this instance. The `instance_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.",
"type": "string"
}
},
"type": "object"
},
"ReportInstanceInfoRequest": {
"description": "Request for notebook instances to report information to Notebooks API.",
"id": "ReportInstanceInfoRequest",
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "The metadata reported to Notebooks API. This will be merged to the instance metadata store",
"type": "object"
},
"vmId": {
"description": "Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity",
"type": "string"
}
},
"type": "object"
},
"ResetInstanceRequest": {
"description": "Request for reseting a notebook instance",
"id": "ResetInstanceRequest",
"properties": {},
"type": "object"
},
"Schedule": {
"description": "The definition of a schedule.",
"id": "Schedule",
"properties": {
"createTime": {
"description": "Output only. Time the schedule was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"cronSchedule": {
"description": "Cron-tab formatted schedule by which the job will execute Format: minute, hour, day of month, month, day of week e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html",
"type": "string"
},
"description": {
"description": "A brief description of this environment.",
"type": "string"
},
"displayName": {
"description": "Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens ‘-’, and underscores ‘_’.",
"readOnly": true,
"type": "string"
},
"executionTemplate": {
"$ref": "ExecutionTemplate",
"description": "Notebook Execution Template corresponding to this schedule."
},
"name": {
"description": "Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
"readOnly": true,
"type": "string"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"ENABLED",
"PAUSED",
"DISABLED",
"UPDATE_FAILED"
],
"enumDescriptions": [
"Unspecified state.",
"The job is executing normally.",
"The job is paused by the user. It will not execute. A user can intentionally pause the job using PauseJobRequest.",
"The job is disabled by the system due to error. The user cannot directly set a job to be disabled.",
"The job state resulting from a failed CloudScheduler.UpdateJob operation. To recover a job from this state, retry CloudScheduler.UpdateJob until a successful response is received."
],
"type": "string"
},
"timeZone": {
"description": "Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string \"utc\". If a time zone is not specified, the default will be in UTC (also known as GMT).",
"type": "string"
},
"updateTime": {
"description": "Output only. TIme the schedule was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SchedulerAcceleratorConfig": {
"description": "Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported.",
"id": "SchedulerAcceleratorConfig",
"properties": {
"coreCount": {
"description": "Count of cores of this accelerator.",
"format": "int64",
"type": "string"
},
"type": {
"description": "Type of this accelerator.",
"enum": [
"SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED",
"NVIDIA_TESLA_K80",
"NVIDIA_TESLA_P100",
"NVIDIA_TESLA_V100",
"NVIDIA_TESLA_P4",
"NVIDIA_TESLA_T4",
"TPU_V2",
"TPU_V3"
],
"enumDescriptions": [
"Unspecified accelerator type. Default to no GPU.",
"Nvidia Tesla K80 GPU.",
"Nvidia Tesla P100 GPU.",
"Nvidia Tesla V100 GPU.",
"Nvidia Tesla P4 GPU.",
"Nvidia Tesla T4 GPU.",
"TPU v2.",
"TPU v3."
],
"type": "string"
}
},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
}
},
"type": "object"
},
"SetInstanceAcceleratorRequest": {
"description": "Request for setting instance accelerator.",
"id": "SetInstanceAcceleratorRequest",
"properties": {
"coreCount": {
"description": "Required. Count of cores of this accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.",
"format": "int64",
"type": "string"
},
"type": {
"description": "Required. Type of this accelerator.",
"enum": [
"ACCELERATOR_TYPE_UNSPECIFIED",
"NVIDIA_TESLA_K80",
"NVIDIA_TESLA_P100",
"NVIDIA_TESLA_V100",
"NVIDIA_TESLA_P4",
"NVIDIA_TESLA_T4",
"NVIDIA_TESLA_A100",
"NVIDIA_TESLA_T4_VWS",
"NVIDIA_TESLA_P100_VWS",
"NVIDIA_TESLA_P4_VWS",
"TPU_V2",
"TPU_V3"
],
"enumDescriptions": [
"Accelerator type is not specified.",
"Accelerator type is Nvidia Tesla K80.",
"Accelerator type is Nvidia Tesla P100.",
"Accelerator type is Nvidia Tesla V100.",
"Accelerator type is Nvidia Tesla P4.",
"Accelerator type is Nvidia Tesla T4.",
"Accelerator type is Nvidia Tesla A100.",
"Accelerator type is NVIDIA Tesla T4 Virtual Workstations.",
"Accelerator type is NVIDIA Tesla P100 Virtual Workstations.",
"Accelerator type is NVIDIA Tesla P4 Virtual Workstations.",
"(Coming soon) Accelerator type is TPU V2.",
"(Coming soon) Accelerator type is TPU V3."
],
"type": "string"
}
},
"type": "object"
},
"SetInstanceLabelsRequest": {
"description": "Request for setting instance labels.",
"id": "SetInstanceLabelsRequest",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this instance. These can be later modified by the setLabels method",
"type": "object"
}
},
"type": "object"
},
"SetInstanceMachineTypeRequest": {
"description": "Request for setting instance machine type.",
"id": "SetInstanceMachineTypeRequest",
"properties": {
"machineType": {
"description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).",
"type": "string"
}
},
"type": "object"
},
"ShieldedInstanceConfig": {
"description": "A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid.",
"id": "ShieldedInstanceConfig",
"properties": {
"enableIntegrityMonitoring": {
"description": "Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.",
"type": "boolean"
},
"enableSecureBoot": {
"description": "Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.",
"type": "boolean"
},
"enableVtpm": {
"description": "Defines whether the instance has the vTPM enabled. Enabled by default.",
"type": "boolean"
}
},
"type": "object"
},
"StartInstanceRequest": {
"description": "Request for starting a notebook instance",
"id": "StartInstanceRequest",
"properties": {},
"type": "object"
},
"Status": {
"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": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"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.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"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"
}
},
"type": "object"
},
"StopInstanceRequest": {
"description": "Request for stopping a notebook instance",
"id": "StopInstanceRequest",
"properties": {},
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TriggerScheduleRequest": {
"description": "Request for created scheduled notebooks",
"id": "TriggerScheduleRequest",
"properties": {},
"type": "object"
},
"UpgradeHistoryEntry": {
"description": "The entry of VM image upgrade history.",
"id": "UpgradeHistoryEntry",
"properties": {
"action": {
"description": "Action. Rolloback or Upgrade.",
"enum": [
"ACTION_UNSPECIFIED",
"UPGRADE",
"ROLLBACK"
],
"enumDescriptions": [
"Operation is not specified.",
"Upgrade.",
"Rollback."
],
"type": "string"
},
"containerImage": {
"description": "The container image before this instance upgrade.",
"type": "string"
},
"createTime": {
"description": "The time that this instance upgrade history entry is created.",
"format": "google-datetime",
"type": "string"
},
"framework": {
"description": "The framework of this notebook instance.",
"type": "string"
},
"snapshot": {
"description": "The snapshot of the boot disk of this notebook instance before upgrade.",
"type": "string"
},
"state": {
"description": "The state of this instance upgrade history entry.",
"enum": [
"STATE_UNSPECIFIED",
"STARTED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"State is not specified.",
"The instance upgrade is started.",
"The instance upgrade is succeeded.",
"The instance upgrade is failed."
],
"type": "string"
},
"targetImage": {
"description": "Target VM Image. Format: ainotebooks-vm/project/image-name/name.",
"type": "string"
},
"version": {
"description": "The version of the notebook instance before this upgrade.",
"type": "string"
},
"vmImage": {
"description": "The VM image before this instance upgrade.",
"type": "string"
}
},
"type": "object"
},
"UpgradeInstanceInternalRequest": {
"description": "Request for upgrading a notebook instance from within the VM",
"id": "UpgradeInstanceInternalRequest",
"properties": {
"vmId": {
"description": "Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity",
"type": "string"
}
},
"type": "object"
},
"UpgradeInstanceRequest": {
"description": "Request for upgrading a notebook instance",
"id": "UpgradeInstanceRequest",
"properties": {},
"type": "object"
},
"VmImage": {
"description": "Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.",
"id": "VmImage",
"properties": {
"imageFamily": {
"description": "Use this VM image family to find the image; the newest image in this family will be used.",
"type": "string"
},
"imageName": {
"description": "Use VM image name to find the image.",
"type": "string"
},
"project": {
"description": "Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Notebooks API",
"version": "v1",
"version_module": true
}