Google Cloud Ai Platform V1 Client - Class NotebookServiceClient (0.37.1)

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

Service Description: The interface for Vertex Notebook service (a.k.a. Colab on Workbench).

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ AIPlatform \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

assignNotebookRuntime

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::assignNotebookRuntimeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\AssignNotebookRuntimeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\AssignNotebookRuntimeRequest;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\NotebookRuntime;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                  The resource name of the Location to get the NotebookRuntime
 *                                                 assignment. Format: `projects/{project}/locations/{location}`
 *                                                 Please see {@see NotebookServiceClient::locationName()} for help formatting this field.
 * @param string $formattedNotebookRuntimeTemplate The resource name of the NotebookRuntimeTemplate based on which a
 *                                                 NotebookRuntime will be assigned (reuse or create a new one). Please see
 *                                                 {@see NotebookServiceClient::notebookRuntimeTemplateName()} for help formatting this field.
 * @param string $notebookRuntimeRuntimeUser       The user email of the NotebookRuntime.
 * @param string $notebookRuntimeDisplayName       The display name of the NotebookRuntime.
 *                                                 The name can be up to 128 characters long and can consist of any UTF-8
 *                                                 characters.
 */
function assign_notebook_runtime_sample(
    string $formattedParent,
    string $formattedNotebookRuntimeTemplate,
    string $notebookRuntimeRuntimeUser,
    string $notebookRuntimeDisplayName
): void {
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $notebookRuntime = (new NotebookRuntime())
        ->setRuntimeUser($notebookRuntimeRuntimeUser)
        ->setDisplayName($notebookRuntimeDisplayName);
    $request = (new AssignNotebookRuntimeRequest())
        ->setParent($formattedParent)
        ->setNotebookRuntimeTemplate($formattedNotebookRuntimeTemplate)
        ->setNotebookRuntime($notebookRuntime);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $notebookServiceClient->assignNotebookRuntime($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var NotebookRuntime $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = NotebookServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $formattedNotebookRuntimeTemplate = NotebookServiceClient::notebookRuntimeTemplateName(
        '[PROJECT]',
        '[LOCATION]',
        '[NOTEBOOK_RUNTIME_TEMPLATE]'
    );
    $notebookRuntimeRuntimeUser = '[RUNTIME_USER]';
    $notebookRuntimeDisplayName = '[DISPLAY_NAME]';

    assign_notebook_runtime_sample(
        $formattedParent,
        $formattedNotebookRuntimeTemplate,
        $notebookRuntimeRuntimeUser,
        $notebookRuntimeDisplayName
    );
}

createNotebookRuntimeTemplate

Creates a NotebookRuntimeTemplate.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::createNotebookRuntimeTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateNotebookRuntimeTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\CreateNotebookRuntimeTemplateRequest;
use Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                    The resource name of the Location to create the
 *                                                   NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`
 *                                                   Please see {@see NotebookServiceClient::locationName()} for help formatting this field.
 * @param string $notebookRuntimeTemplateDisplayName The display name of the NotebookRuntimeTemplate.
 *                                                   The name can be up to 128 characters long and can consist of any UTF-8
 *                                                   characters.
 */
function create_notebook_runtime_template_sample(
    string $formattedParent,
    string $notebookRuntimeTemplateDisplayName
): void {
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $notebookRuntimeTemplate = (new NotebookRuntimeTemplate())
        ->setDisplayName($notebookRuntimeTemplateDisplayName);
    $request = (new CreateNotebookRuntimeTemplateRequest())
        ->setParent($formattedParent)
        ->setNotebookRuntimeTemplate($notebookRuntimeTemplate);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $notebookServiceClient->createNotebookRuntimeTemplate($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var NotebookRuntimeTemplate $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = NotebookServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $notebookRuntimeTemplateDisplayName = '[DISPLAY_NAME]';

    create_notebook_runtime_template_sample($formattedParent, $notebookRuntimeTemplateDisplayName);
}

deleteNotebookRuntime

Deletes a NotebookRuntime.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::deleteNotebookRuntimeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the NotebookRuntime resource to be deleted.
 *                              Instead of checking whether the name is in valid NotebookRuntime resource
 *                              name format, directly throw NotFound exception if there is no such
 *                              NotebookRuntime in spanner. Please see
 *                              {@see NotebookServiceClient::notebookRuntimeName()} for help formatting this field.
 */
function delete_notebook_runtime_sample(string $formattedName): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new DeleteNotebookRuntimeRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $notebookServiceClient->deleteNotebookRuntime($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = NotebookServiceClient::notebookRuntimeName(
        '[PROJECT]',
        '[LOCATION]',
        '[NOTEBOOK_RUNTIME]'
    );

    delete_notebook_runtime_sample($formattedName);
}

deleteNotebookRuntimeTemplate

Deletes a NotebookRuntimeTemplate.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::deleteNotebookRuntimeTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeTemplateRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the NotebookRuntimeTemplate resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
 *                              Please see {@see NotebookServiceClient::notebookRuntimeTemplateName()} for help formatting this field.
 */
function delete_notebook_runtime_template_sample(string $formattedName): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new DeleteNotebookRuntimeTemplateRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $notebookServiceClient->deleteNotebookRuntimeTemplate($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = NotebookServiceClient::notebookRuntimeTemplateName(
        '[PROJECT]',
        '[LOCATION]',
        '[NOTEBOOK_RUNTIME_TEMPLATE]'
    );

    delete_notebook_runtime_template_sample($formattedName);
}

getNotebookRuntime

Gets a NotebookRuntime.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::getNotebookRuntimeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetNotebookRuntimeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\NotebookRuntime`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\GetNotebookRuntimeRequest;
use Google\Cloud\AIPlatform\V1\NotebookRuntime;

/**
 * @param string $formattedName The name of the NotebookRuntime resource.
 *                              Instead of checking whether the name is in valid NotebookRuntime resource
 *                              name format, directly throw NotFound exception if there is no such
 *                              NotebookRuntime in spanner. Please see
 *                              {@see NotebookServiceClient::notebookRuntimeName()} for help formatting this field.
 */
function get_notebook_runtime_sample(string $formattedName): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new GetNotebookRuntimeRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var NotebookRuntime $response */
        $response = $notebookServiceClient->getNotebookRuntime($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = NotebookServiceClient::notebookRuntimeName(
        '[PROJECT]',
        '[LOCATION]',
        '[NOTEBOOK_RUNTIME]'
    );

    get_notebook_runtime_sample($formattedName);
}

getNotebookRuntimeTemplate

Gets a NotebookRuntimeTemplate.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::getNotebookRuntimeTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetNotebookRuntimeTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\GetNotebookRuntimeTemplateRequest;
use Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate;

/**
 * @param string $formattedName The name of the NotebookRuntimeTemplate resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
 *                              Please see {@see NotebookServiceClient::notebookRuntimeTemplateName()} for help formatting this field.
 */
function get_notebook_runtime_template_sample(string $formattedName): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new GetNotebookRuntimeTemplateRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var NotebookRuntimeTemplate $response */
        $response = $notebookServiceClient->getNotebookRuntimeTemplate($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = NotebookServiceClient::notebookRuntimeTemplateName(
        '[PROJECT]',
        '[LOCATION]',
        '[NOTEBOOK_RUNTIME_TEMPLATE]'
    );

    get_notebook_runtime_template_sample($formattedName);
}

listNotebookRuntimeTemplates

Lists NotebookRuntimeTemplates in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::listNotebookRuntimeTemplatesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListNotebookRuntimeTemplatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\ListNotebookRuntimeTemplatesRequest;
use Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate;

/**
 * @param string $formattedParent The resource name of the Location from which to list the
 *                                NotebookRuntimeTemplates.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see NotebookServiceClient::locationName()} for help formatting this field.
 */
function list_notebook_runtime_templates_sample(string $formattedParent): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new ListNotebookRuntimeTemplatesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $notebookServiceClient->listNotebookRuntimeTemplates($request);

        /** @var NotebookRuntimeTemplate $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = NotebookServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_notebook_runtime_templates_sample($formattedParent);
}

listNotebookRuntimes

Lists NotebookRuntimes in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::listNotebookRuntimesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListNotebookRuntimesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\ListNotebookRuntimesRequest;
use Google\Cloud\AIPlatform\V1\NotebookRuntime;

/**
 * @param string $formattedParent The resource name of the Location from which to list the
 *                                NotebookRuntimes.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see NotebookServiceClient::locationName()} for help formatting this field.
 */
function list_notebook_runtimes_sample(string $formattedParent): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new ListNotebookRuntimesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $notebookServiceClient->listNotebookRuntimes($request);

        /** @var NotebookRuntime $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = NotebookServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_notebook_runtimes_sample($formattedParent);
}

startNotebookRuntime

Starts a NotebookRuntime.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::startNotebookRuntimeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\StartNotebookRuntimeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\StartNotebookRuntimeRequest;
use Google\Cloud\AIPlatform\V1\StartNotebookRuntimeResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the NotebookRuntime resource to be started.
 *                              Instead of checking whether the name is in valid NotebookRuntime resource
 *                              name format, directly throw NotFound exception if there is no such
 *                              NotebookRuntime in spanner. Please see
 *                              {@see NotebookServiceClient::notebookRuntimeName()} for help formatting this field.
 */
function start_notebook_runtime_sample(string $formattedName): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new StartNotebookRuntimeRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $notebookServiceClient->startNotebookRuntime($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var StartNotebookRuntimeResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = NotebookServiceClient::notebookRuntimeName(
        '[PROJECT]',
        '[LOCATION]',
        '[NOTEBOOK_RUNTIME]'
    );

    start_notebook_runtime_sample($formattedName);
}

upgradeNotebookRuntime

Upgrades a NotebookRuntime.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::upgradeNotebookRuntimeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeRequest;
use Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the NotebookRuntime resource to be upgrade.
 *                              Instead of checking whether the name is in valid NotebookRuntime resource
 *                              name format, directly throw NotFound exception if there is no such
 *                              NotebookRuntime in spanner. Please see
 *                              {@see NotebookServiceClient::notebookRuntimeName()} for help formatting this field.
 */
function upgrade_notebook_runtime_sample(string $formattedName): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new UpgradeNotebookRuntimeRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $notebookServiceClient->upgradeNotebookRuntime($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var UpgradeNotebookRuntimeResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = NotebookServiceClient::notebookRuntimeName(
        '[PROJECT]',
        '[LOCATION]',
        '[NOTEBOOK_RUNTIME]'
    );

    upgrade_notebook_runtime_sample($formattedName);
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $notebookServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $notebookServiceClient->listLocations($request);

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $notebookServiceClient->getIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $notebookServiceClient->setIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

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.

The async variant is Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\TestIamPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement 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).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $notebookServiceClient = new NotebookServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $notebookServiceClient->testIamPermissions($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

assignNotebookRuntimeAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\AssignNotebookRuntimeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createNotebookRuntimeTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateNotebookRuntimeTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteNotebookRuntimeAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteNotebookRuntimeTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getNotebookRuntimeAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetNotebookRuntimeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getNotebookRuntimeTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetNotebookRuntimeTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listNotebookRuntimeTemplatesAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListNotebookRuntimeTemplatesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listNotebookRuntimesAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListNotebookRuntimesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

startNotebookRuntimeAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\StartNotebookRuntimeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

upgradeNotebookRuntimeAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameters
Name	Description
`project`	`string`
`network`	`string`

Returns
Type	Description
`string`	The formatted network resource.

static::notebookRuntimeName

Formats a string containing the fully-qualified path to represent a notebook_runtime resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`notebookRuntime`	`string`

Returns
Type	Description
`string`	The formatted notebook_runtime resource.

static::notebookRuntimeTemplateName

Formats a string containing the fully-qualified path to represent a notebook_runtime_template resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`notebookRuntimeTemplate`	`string`

Returns
Type	Description
`string`	The formatted notebook_runtime_template resource.

static::subnetworkName

Formats a string containing the fully-qualified path to represent a subnetwork resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`subnetwork`	`string`

Returns
Type	Description
`string`	The formatted subnetwork resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

location: projects/{project}/locations/{location}
network: projects/{project}/global/networks/{network}
notebookRuntime: projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}
notebookRuntimeTemplate: projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}
subnetwork: projects/{project}/regions/{region}/subnetworks/{subnetwork}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.