Google Cloud Ai Platform V1 Client - Class AssignNotebookRuntimeRequest (1.22.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class AssignNotebookRuntimeRequest.

Request message for NotebookService.AssignNotebookRuntime.

Generated from protobuf message google.cloud.aiplatform.v1.AssignNotebookRuntimeRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}
↳ notebook_runtime_template string

Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one).
↳ notebook_runtime NotebookRuntime

Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.
↳ notebook_runtime_id string

Optional. User specified ID for the notebook runtime.

getParent

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}

Returns
Type Description
string

setParent

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getNotebookRuntimeTemplate

Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one).

Returns
Type Description
string

setNotebookRuntimeTemplate

Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one).

Parameter
Name Description
var string
Returns
Type Description
$this

getNotebookRuntime

Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.

Returns
Type Description
NotebookRuntime|null

hasNotebookRuntime

clearNotebookRuntime

setNotebookRuntime

Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.

Parameter
Name Description
var NotebookRuntime
Returns
Type Description
$this

getNotebookRuntimeId

Optional. User specified ID for the notebook runtime.

Returns
Type Description
string

setNotebookRuntimeId

Optional. User specified ID for the notebook runtime.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location} Please see NotebookServiceClient::locationName() for help formatting this field.
notebookRuntimeTemplate string

Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one). Please see NotebookServiceClient::notebookRuntimeTemplateName() for help formatting this field.
notebookRuntime NotebookRuntime

Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.
notebookRuntimeId string

Optional. User specified ID for the notebook runtime.
Returns
Type Description
AssignNotebookRuntimeRequest