@datafire/google_notebooks
Client library for Notebooks API
Installation and Usage
npm install --save @datafire/google_notebooks
let google_notebooks = require('@datafire/google_notebooks').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
AI Platform Notebooks API is used to manage notebook resources in Google Cloud.
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
google_notebooks.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
google_notebooks.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
notebooks.projects.locations.operations.delete
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
.
google_notebooks.notebooks.projects.locations.operations.delete({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the operation resource to be deleted. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Empty
notebooks.projects.locations.operations.get
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.
google_notebooks.notebooks.projects.locations.operations.get({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the operation resource. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.list
Lists information about the supported locations for this service.
google_notebooks.notebooks.projects.locations.list({
"name": ""
}, context)
Input
- input
object
- name required
string
: The resource that owns the locations collection, if applicable. - filter
string
: The standard list filter. - pageSize
integer
: The standard list page size. - pageToken
string
: The standard list page token. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output ListLocationsResponse
notebooks.projects.locations.operations.list
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.
google_notebooks.notebooks.projects.locations.operations.list({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the operation's parent resource. - filter
string
: The standard list filter. - pageSize
integer
: The standard list page size. - pageToken
string
: The standard list page token. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output ListOperationsResponse
notebooks.projects.locations.operations.cancel
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
.
google_notebooks.notebooks.projects.locations.operations.cancel({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the operation resource to be cancelled. - body CancelOperationRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Empty
notebooks.projects.locations.instances.report
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.
google_notebooks.notebooks.projects.locations.instances.report({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body ReportInstanceInfoRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.reset
Resets a notebook instance.
google_notebooks.notebooks.projects.locations.instances.reset({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body ResetInstanceRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.setAccelerator
Updates the guest accelerators of a single Instance.
google_notebooks.notebooks.projects.locations.instances.setAccelerator({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body SetInstanceAcceleratorRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.setLabels
Replaces all the labels of an Instance.
google_notebooks.notebooks.projects.locations.instances.setLabels({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body SetInstanceLabelsRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.setMachineType
Updates the machine type of a single Instance.
google_notebooks.notebooks.projects.locations.instances.setMachineType({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body SetInstanceMachineTypeRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.start
Starts a notebook instance.
google_notebooks.notebooks.projects.locations.instances.start({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body StartInstanceRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.stop
Stops a notebook instance.
google_notebooks.notebooks.projects.locations.instances.stop({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body StopInstanceRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.upgrade
Upgrades a notebook instance to the latest version.
google_notebooks.notebooks.projects.locations.instances.upgrade({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body UpgradeInstanceRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.upgradeInternal
Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
google_notebooks.notebooks.projects.locations.instances.upgradeInternal({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- body UpgradeInstanceInternalRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Operation
notebooks.projects.locations.instances.isUpgradeable
Check if a notebook instance is upgradable.
google_notebooks.notebooks.projects.locations.instances.isUpgradeable({
"notebookInstance": ""
}, context)
Input
- input
object
- notebookInstance required
string
: Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- notebookInstance required
Output
notebooks.projects.locations.environments.list
Lists environments in a project.
google_notebooks.notebooks.projects.locations.environments.list({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: Required. Format:projects/{project_id}/locations/{location}
- pageSize
integer
: Maximum return size of the list call. - pageToken
string
: A previous returned page token that can be used to continue listing from the last result. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output ListEnvironmentsResponse
notebooks.projects.locations.environments.create
Creates a new Environment.
google_notebooks.notebooks.projects.locations.environments.create({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: Required. Format:projects/{project_id}/locations/{location}
- environmentId
string
: Required. User-defined unique ID of this environment. Theenvironment_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. - body Environment
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
notebooks.projects.locations.instances.list
Lists instances in a given project and location.
google_notebooks.notebooks.projects.locations.instances.list({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: Required. Format:parent=projects/{project_id}/locations/{location}
- pageSize
integer
: Maximum return size of the list call. - pageToken
string
: A previous returned page token that can be used to continue listing from the last result. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output ListInstancesResponse
notebooks.projects.locations.instances.create
Creates a new Instance in a given project and location.
google_notebooks.notebooks.projects.locations.instances.create({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: Required. Format:parent=projects/{project_id}/locations/{location}
- instanceId
string
: Required. User-defined unique ID of this instance. - body Instance
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
notebooks.projects.locations.instances.register
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.
google_notebooks.notebooks.projects.locations.instances.register({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: Required. Format:parent=projects/{project_id}/locations/{location}
- body RegisterInstanceRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
notebooks.projects.locations.instances.getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
google_notebooks.notebooks.projects.locations.instances.getIamPolicy({
"resource": ""
}, context)
Input
- input
object
- resource required
string
: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - options.requestedPolicyVersion
integer
: 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. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- resource required
Output
- output Policy
notebooks.projects.locations.instances.setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
google_notebooks.notebooks.projects.locations.instances.setIamPolicy({
"resource": ""
}, context)
Input
- input
object
- resource required
string
: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - body SetIamPolicyRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- resource required
Output
- output Policy
notebooks.projects.locations.instances.testIamPermissions
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.
google_notebooks.notebooks.projects.locations.instances.testIamPermissions({
"resource": ""
}, context)
Input
- input
object
- resource required
string
: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - body TestIamPermissionsRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- resource required
Output
- output TestIamPermissionsResponse
Definitions
AcceleratorConfig
- AcceleratorConfig
object
: Definition of a hardware accelerator. Note that not all combinations oftype
andcore_count
are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported.- coreCount
string
: Count of cores of this accelerator. - type
string
(values: 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): Type of this accelerator.
- coreCount
Binding
- Binding
object
: Associatesmembers
with arole
.- condition Expr
- members
array
: 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 touser:{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 toserviceAccount:{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 togroup:{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
orexample.com
.- items
string
- items
- role
string
: Role that is assigned tomembers
. For example,roles/viewer
,roles/editor
, orroles/owner
.
CancelOperationRequest
- CancelOperationRequest
object
: The request message for Operations.CancelOperation.
ContainerImage
- ContainerImage
object
: Definition of a container image for starting a notebook instance with the environment installed in a container.- repository
string
: Required. The path to the container image repository. For example:gcr.io/{project_id}/{image_name}
- tag
string
: The tag of the container image. If not specified, this defaults to the latest tag.
- repository
Disk
- Disk
object
: An instance-attached disk resource.- autoDelete
boolean
: Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). - boot
boolean
: Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. - deviceName
string
: 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. - diskSizeGb
string
: Indicates the size of the disk in base-2 GB. - guestOsFeatures
array
: 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 GuestOsFeature
- index
string
: 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. - interface
string
: 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 - kind
string
: Type of the resource. Always compute#attachedDisk for attached disks. - licenses
array
: 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
string
- items
- mode
string
: 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 - source
string
: Indicates a valid partial or full URL to an existing Persistent Disk resource. - type
string
: Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH
- autoDelete
Empty
- Empty
object
: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation forEmpty
is empty JSON object{}
.
Environment
- Environment
object
: Definition of a software environment that is used to start a notebook instance.- containerImage ContainerImage
- createTime
string
: Output only. The time at which this environment was created. - description
string
: A brief description of this environment. - displayName
string
: Display name of this environment for the UI. - name
string
: Output only. Name of this environment. Format:projects/{project_id}/locations/{location}/environments/{environment_id}
- postStartupScript
string
: 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"
- vmImage VmImage
Expr
- Expr
object
: 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() < 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' && 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.- description
string
: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - expression
string
: Textual representation of an expression in Common Expression Language syntax. - location
string
: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - title
string
: 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.
- description
GuestOsFeature
- GuestOsFeature
object
: Guest OS features for boot disk.- type
string
: 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
Instance
- Instance
object
: The definition of a notebook instance.- acceleratorConfig AcceleratorConfig
- bootDiskSizeGb
string
: 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. - bootDiskType
string
(values: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED): Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD
). - containerImage ContainerImage
- createTime
string
: Output only. Instance creation time. - customGpuDriverPath
string
: Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. - dataDiskSizeGb
string
: 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. - dataDiskType
string
(values: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED): Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD
). - diskEncryption
string
(values: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK): Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. - disks
array
: Output only. Attached disks to notebook instance.- items Disk
- installGpuDriver
boolean
: 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. - instanceOwners
array
: 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
string
- items
- kmsKey
string
: 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. - labels
object
: Labels to apply to this instance. These can be later modified by the setLabels method. - machineType
string
: Required. The Compute Engine machine type of this instance. - metadata
object
: Custom metadata to apply to this instance. - name
string
: Output only. The name of this notebook instance. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
- network
string
: The name of the VPC that this instance is in. Format:projects/{project_id}/global/networks/{network_id}
- noProxyAccess
boolean
: If true, the notebook instance will not register with the proxy. - noPublicIp
boolean
: If true, no public IP will be assigned to this instance. - noRemoveDataDisk
boolean
: Input only. If true, the data disk will not be auto deleted when deleting the instance. - postStartupScript
string
: 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). - proxyUri
string
: Output only. The proxy endpoint that is used to access the Jupyter notebook. - serviceAccount
string
: 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 is used. - state
string
(values: STATE_UNSPECIFIED, STARTING, PROVISIONING, ACTIVE, STOPPING, STOPPED, DELETED, UPGRADING, INITIALIZING, REGISTERING): Output only. The state of this instance. - subnet
string
: The name of the subnet that this instance is in. Format:projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
- updateTime
string
: Output only. Instance update time. - upgradeHistory
array
: The upgrade history of this instance.- items UpgradeHistoryEntry
- vmImage VmImage
IsInstanceUpgradeableResponse
- IsInstanceUpgradeableResponse
object
: Response for checking if a notebook instance is upgradeable.- upgradeInfo
string
: Additional information about upgrade. - upgradeVersion
string
: The version this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true. - upgradeable
boolean
: If an instance is upgradeable.
- upgradeInfo
ListEnvironmentsResponse
- ListEnvironmentsResponse
object
: Response for listing environments.- environments
array
: A list of returned environments.- items Environment
- nextPageToken
string
: A page token that can be used to continue listing from the last result in the next list call. - unreachable
array
: Locations that could not be reached.- items
string
- items
- environments
ListInstancesResponse
- ListInstancesResponse
object
: Response for listing notebook instances.- instances
array
: A list of returned instances.- items Instance
- nextPageToken
string
: Page token that can be used to continue listing from the last result in the next list call. - unreachable
array
: Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables,- items
string
- items
- instances
ListLocationsResponse
- ListLocationsResponse
object
: The response message for Locations.ListLocations.- locations
array
: A list of locations that matches the specified filter in the request.- items Location
- nextPageToken
string
: The standard List next-page token.
- locations
ListOperationsResponse
- ListOperationsResponse
object
: The response message for Operations.ListOperations.- nextPageToken
string
: The standard List next-page token. - operations
array
: A list of operations that matches the specified filter in the request.- items Operation
- nextPageToken
Location
- Location
object
: A resource that represents Google Cloud Platform location.- displayName
string
: The friendly name for this location, typically a nearby city name. For example, "Tokyo". - labels
object
: Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} - locationId
string
: The canonical id for this location. For example:"us-east1"
. - metadata
object
: Service-specific metadata. For example the available capacity at the given location. - name
string
: Resource name for the location, which may vary between implementations. For example:"projects/example-project/locations/us-east1"
- displayName
Operation
- Operation
object
: This resource represents a long-running operation that is the result of a network API call.- done
boolean
: If the value isfalse
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available. - error Status
- metadata
object
: 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. - name
string
: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, thename
should be a resource name ending withoperations/{unique_id}
. - response
object
: The normal response of the operation in case of success. If the original method returns no data on success, such asDelete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
- done
OperationMetadata
- OperationMetadata
object
: Represents the metadata of the long-running operation.- apiVersion
string
: API version used to start the operation. - createTime
string
: The time the operation was created. - endTime
string
: The time the operation finished running. - endpoint
string
: API endpoint name of this operation. - requestedCancellation
boolean
: 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 toCode.CANCELLED
. - statusMessage
string
: Human-readable status of the operation, if any. - target
string
: Server-defined resource path for the target of the operation. - verb
string
: Name of the verb executed by the operation.
- apiVersion
Policy
- Policy
object
: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. APolicy
is a collection ofbindings
. Abinding
binds one or moremembers
to a singlerole
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Arole
is a named list of permissions; eachrole
can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, abinding
can also specify acondition
, which is a logical expression that allows access to a resource only if the expression evaluates totrue
. 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. 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 < 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 < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.- bindings
array
: Associates a list ofmembers
to arole
. Optionally, may specify acondition
that determines how and when thebindings
are applied. Each of thebindings
must contain at least one member.- items Binding
- etag
string
: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 theetag
in the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetag
is returned in the response togetIamPolicy
, and systems are expected to put that etag in the request tosetIamPolicy
to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include theetag
field whenever you callsetIamPolicy
. If you omit this field, then IAM allows you to overwrite a version3
policy with a version1
policy, and all of the conditions in the version3
policy are lost. - version
integer
: Specifies the format of the policy. Valid values are0
,1
, and3
. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version3
. 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 theetag
field whenever you callsetIamPolicy
. If you omit this field, then IAM allows you to overwrite a version3
policy with a version1
policy, and all of the conditions in the version3
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.
- bindings
RegisterInstanceRequest
- RegisterInstanceRequest
object
: Request for registering a notebook instance.- instanceId
string
: Required. User defined unique ID of this instance. Theinstance_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.
- instanceId
ReportInstanceInfoRequest
- ReportInstanceInfoRequest
object
: Request for notebook instances to report information to Notebooks API.- metadata
object
: The metadata reported to Notebooks API. This will be merged to the instance metadata store - vmId
string
: Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
- metadata
ResetInstanceRequest
- ResetInstanceRequest
object
: Request for reseting a notebook instance
SetIamPolicyRequest
- SetIamPolicyRequest
object
: Request message forSetIamPolicy
method.- policy Policy
SetInstanceAcceleratorRequest
- SetInstanceAcceleratorRequest
object
: Request for setting instance accelerator.- coreCount
string
: Required. Count of cores of this accelerator. Note that not all combinations oftype
andcore_count
are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. - type
string
(values: 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): Required. Type of this accelerator.
- coreCount
SetInstanceLabelsRequest
- SetInstanceLabelsRequest
object
: Request for setting instance labels.- labels
object
: Labels to apply to this instance. These can be later modified by the setLabels method
- labels
SetInstanceMachineTypeRequest
- SetInstanceMachineTypeRequest
object
: Request for setting instance machine type.- machineType
string
: Required. The Compute Engine machine type.
- machineType
StartInstanceRequest
- StartInstanceRequest
object
: Request for starting a notebook instance
Status
- Status
object
: TheStatus
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. EachStatus
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.- code
integer
: The status code, which should be an enum value of google.rpc.Code. - details
array
: A list of messages that carry the error details. There is a common set of message types for APIs to use.- items
object
- items
- message
string
: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
StopInstanceRequest
- StopInstanceRequest
object
: Request for stopping a notebook instance
TestIamPermissionsRequest
- TestIamPermissionsRequest
object
: Request message forTestIamPermissions
method.- permissions
array
: The set of permissions to check for theresource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.- items
string
- items
- permissions
TestIamPermissionsResponse
- TestIamPermissionsResponse
object
: Response message forTestIamPermissions
method.- permissions
array
: A subset ofTestPermissionsRequest.permissions
that the caller is allowed.- items
string
- items
- permissions
UpgradeHistoryEntry
- UpgradeHistoryEntry
object
- containerImage
string
: The container image before this instance upgrade. - createTime
string
: The time that this instance upgrade history entry is created. - framework
string
: The framework of this notebook instance. - snapshot
string
: The snapshot of the boot disk of this notebook instance before upgrade. - state
string
(values: STATE_UNSPECIFIED, STARTED, SUCCEEDED, FAILED): The state of this instance upgrade history entry. - version
string
: The version of the notebook instance before this upgrade. - vmImage
string
: The VM image before this instance upgrade.
- containerImage
UpgradeInstanceInternalRequest
- UpgradeInstanceInternalRequest
object
: Request for upgrading a notebook instance from within the VM- vmId
string
: Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
- vmId
UpgradeInstanceRequest
- UpgradeInstanceRequest
object
: Request for upgrading a notebook instance
VmImage
- VmImage
object
: Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.- imageFamily
string
: Use this VM image family to find the image; the newest image in this family will be used. - imageName
string
: Use VM image name to find the image. - project
string
: Required. The name of the Google Cloud project that this VM image belongs to. Format:projects/{project_id}
- imageFamily