NotebookService

google.cloud.notebooks.v1beta1. NotebookService

Represents a NotebookService

Constructor

new NotebookService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new NotebookService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createEnvironment(request, callback) → {undefined}

Calls CreateEnvironment.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ICreateEnvironmentRequest

CreateEnvironmentRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.CreateEnvironmentCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

createEnvironment(request) → {Promise.<google.longrunning.Operation>}

Calls CreateEnvironment.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ICreateEnvironmentRequest

CreateEnvironmentRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

createInstance(request, callback) → {undefined}

Calls CreateInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ICreateInstanceRequest

CreateInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.CreateInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

createInstance(request) → {Promise.<google.longrunning.Operation>}

Calls CreateInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ICreateInstanceRequest

CreateInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteEnvironment(request, callback) → {undefined}

Calls DeleteEnvironment.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IDeleteEnvironmentRequest

DeleteEnvironmentRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.DeleteEnvironmentCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

deleteEnvironment(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteEnvironment.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IDeleteEnvironmentRequest

DeleteEnvironmentRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteInstance(request, callback) → {undefined}

Calls DeleteInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.DeleteInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

deleteInstance(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getEnvironment(request, callback) → {undefined}

Calls GetEnvironment.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IGetEnvironmentRequest

GetEnvironmentRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.GetEnvironmentCallback

Node-style callback called with the error, if any, and Environment
Returns:
Type Description
undefined

getEnvironment(request) → {Promise.<google.cloud.notebooks.v1beta1.Environment>}

Calls GetEnvironment.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IGetEnvironmentRequest

GetEnvironmentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.notebooks.v1beta1.Environment>

Promise

getInstance(request, callback) → {undefined}

Calls GetInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IGetInstanceRequest

GetInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.GetInstanceCallback

Node-style callback called with the error, if any, and Instance
Returns:
Type Description
undefined

getInstance(request) → {Promise.<google.cloud.notebooks.v1beta1.Instance>}

Calls GetInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IGetInstanceRequest

GetInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.notebooks.v1beta1.Instance>

Promise

isInstanceUpgradeable(request, callback) → {undefined}

Calls IsInstanceUpgradeable.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IIsInstanceUpgradeableRequest

IsInstanceUpgradeableRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.IsInstanceUpgradeableCallback

Node-style callback called with the error, if any, and IsInstanceUpgradeableResponse
Returns:
Type Description
undefined

isInstanceUpgradeable(request) → {Promise.<google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse>}

Calls IsInstanceUpgradeable.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IIsInstanceUpgradeableRequest

IsInstanceUpgradeableRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse>

Promise

listEnvironments(request, callback) → {undefined}

Calls ListEnvironments.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IListEnvironmentsRequest

ListEnvironmentsRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.ListEnvironmentsCallback

Node-style callback called with the error, if any, and ListEnvironmentsResponse
Returns:
Type Description
undefined

listEnvironments(request) → {Promise.<google.cloud.notebooks.v1beta1.ListEnvironmentsResponse>}

Calls ListEnvironments.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IListEnvironmentsRequest

ListEnvironmentsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.notebooks.v1beta1.ListEnvironmentsResponse>

Promise

listInstances(request, callback) → {undefined}

Calls ListInstances.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IListInstancesRequest

ListInstancesRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.ListInstancesCallback

Node-style callback called with the error, if any, and ListInstancesResponse
Returns:
Type Description
undefined

listInstances(request) → {Promise.<google.cloud.notebooks.v1beta1.ListInstancesResponse>}

Calls ListInstances.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IListInstancesRequest

ListInstancesRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.notebooks.v1beta1.ListInstancesResponse>

Promise

registerInstance(request, callback) → {undefined}

Calls RegisterInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IRegisterInstanceRequest

RegisterInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.RegisterInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

registerInstance(request) → {Promise.<google.longrunning.Operation>}

Calls RegisterInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IRegisterInstanceRequest

RegisterInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

reportInstanceInfo(request, callback) → {undefined}

Calls ReportInstanceInfo.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IReportInstanceInfoRequest

ReportInstanceInfoRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.ReportInstanceInfoCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

reportInstanceInfo(request) → {Promise.<google.longrunning.Operation>}

Calls ReportInstanceInfo.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IReportInstanceInfoRequest

ReportInstanceInfoRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

resetInstance(request, callback) → {undefined}

Calls ResetInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IResetInstanceRequest

ResetInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.ResetInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

resetInstance(request) → {Promise.<google.longrunning.Operation>}

Calls ResetInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IResetInstanceRequest

ResetInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

setInstanceAccelerator(request, callback) → {undefined}

Calls SetInstanceAccelerator.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ISetInstanceAcceleratorRequest

SetInstanceAcceleratorRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.SetInstanceAcceleratorCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

setInstanceAccelerator(request) → {Promise.<google.longrunning.Operation>}

Calls SetInstanceAccelerator.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ISetInstanceAcceleratorRequest

SetInstanceAcceleratorRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

setInstanceLabels(request, callback) → {undefined}

Calls SetInstanceLabels.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ISetInstanceLabelsRequest

SetInstanceLabelsRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.SetInstanceLabelsCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

setInstanceLabels(request) → {Promise.<google.longrunning.Operation>}

Calls SetInstanceLabels.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ISetInstanceLabelsRequest

SetInstanceLabelsRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

setInstanceMachineType(request, callback) → {undefined}

Calls SetInstanceMachineType.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ISetInstanceMachineTypeRequest

SetInstanceMachineTypeRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.SetInstanceMachineTypeCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

setInstanceMachineType(request) → {Promise.<google.longrunning.Operation>}

Calls SetInstanceMachineType.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.ISetInstanceMachineTypeRequest

SetInstanceMachineTypeRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

startInstance(request, callback) → {undefined}

Calls StartInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IStartInstanceRequest

StartInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.StartInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

startInstance(request) → {Promise.<google.longrunning.Operation>}

Calls StartInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IStartInstanceRequest

StartInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

stopInstance(request, callback) → {undefined}

Calls StopInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IStopInstanceRequest

StopInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.StopInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

stopInstance(request) → {Promise.<google.longrunning.Operation>}

Calls StopInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IStopInstanceRequest

StopInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

upgradeInstance(request, callback) → {undefined}

Calls UpgradeInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IUpgradeInstanceRequest

UpgradeInstanceRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.UpgradeInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

upgradeInstance(request) → {Promise.<google.longrunning.Operation>}

Calls UpgradeInstance.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IUpgradeInstanceRequest

UpgradeInstanceRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

upgradeInstanceInternal(request, callback) → {undefined}

Calls UpgradeInstanceInternal.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IUpgradeInstanceInternalRequest

UpgradeInstanceInternalRequest message or plain object
callback google.cloud.notebooks.v1beta1.NotebookService.UpgradeInstanceInternalCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

upgradeInstanceInternal(request) → {Promise.<google.longrunning.Operation>}

Calls UpgradeInstanceInternal.

Parameters:
Name Type Description
request google.cloud.notebooks.v1beta1.IUpgradeInstanceInternalRequest

UpgradeInstanceInternalRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {NotebookService}

Creates new NotebookService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
NotebookService

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateEnvironmentCallback(error, responseopt)

Callback as used by createEnvironment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

CreateInstanceCallback(error, responseopt)

Callback as used by createInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

DeleteEnvironmentCallback(error, responseopt)

Callback as used by deleteEnvironment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

DeleteInstanceCallback(error, responseopt)

Callback as used by deleteInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

GetEnvironmentCallback(error, responseopt)

Callback as used by getEnvironment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.notebooks.v1beta1.Environment <optional>

Environment

GetInstanceCallback(error, responseopt)

Callback as used by getInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.notebooks.v1beta1.Instance <optional>

Instance

IsInstanceUpgradeableCallback(error, responseopt)

Callback as used by isInstanceUpgradeable.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse <optional>

IsInstanceUpgradeableResponse

ListEnvironmentsCallback(error, responseopt)

Callback as used by listEnvironments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.notebooks.v1beta1.ListEnvironmentsResponse <optional>

ListEnvironmentsResponse

ListInstancesCallback(error, responseopt)

Callback as used by listInstances.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.notebooks.v1beta1.ListInstancesResponse <optional>

ListInstancesResponse

RegisterInstanceCallback(error, responseopt)

Callback as used by registerInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

ReportInstanceInfoCallback(error, responseopt)

Callback as used by reportInstanceInfo.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

ResetInstanceCallback(error, responseopt)

Callback as used by resetInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

SetInstanceAcceleratorCallback(error, responseopt)

Callback as used by setInstanceAccelerator.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

SetInstanceLabelsCallback(error, responseopt)

Callback as used by setInstanceLabels.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

SetInstanceMachineTypeCallback(error, responseopt)

Callback as used by setInstanceMachineType.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

StartInstanceCallback(error, responseopt)

Callback as used by startInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

StopInstanceCallback(error, responseopt)

Callback as used by stopInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

UpgradeInstanceCallback(error, responseopt)

Callback as used by upgradeInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

UpgradeInstanceInternalCallback(error, responseopt)

Callback as used by upgradeInstanceInternal.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation