Reference documentation and code samples for the Google Cloud Notebooks V1 Client class ManagedNotebookServiceClient.
Service Description: API v1 service for Managed Notebooks.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Notebooks \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
createRuntime
Creates a new Runtime in a given project and location.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::createRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\CreateRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\CreateRuntimeRequest;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Rpc\Status;
/**
* @param string $formattedParent Format:
* `parent=projects/{project_id}/locations/{location}`
* Please see {@see ManagedNotebookServiceClient::runtimeName()} for help formatting this field.
* @param string $runtimeId User-defined unique ID of this Runtime.
*/
function create_runtime_sample(string $formattedParent, string $runtimeId): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$runtime = new Runtime();
$request = (new CreateRuntimeRequest())
->setParent($formattedParent)
->setRuntimeId($runtimeId)
->setRuntime($runtime);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->createRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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 = ManagedNotebookServiceClient::runtimeName(
'[PROJECT]',
'[LOCATION]',
'[RUNTIME]'
);
$runtimeId = '[RUNTIME_ID]';
create_runtime_sample($formattedParent, $runtimeId);
}
deleteRuntime
Deletes a single Runtime.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::deleteRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\DeleteRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\DeleteRuntimeRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
* Please see {@see ManagedNotebookServiceClient::runtimeName()} for help formatting this field.
*/
function delete_runtime_sample(string $formattedName): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new DeleteRuntimeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->deleteRuntime($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 = ManagedNotebookServiceClient::runtimeName('[PROJECT]', '[LOCATION]', '[RUNTIME]');
delete_runtime_sample($formattedName);
}
diagnoseRuntime
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::diagnoseRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\DiagnoseRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\DiagnoseRuntimeRequest;
use Google\Cloud\Notebooks\V1\DiagnosticConfig;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Rpc\Status;
/**
* @param string $formattedName Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
* Please see {@see ManagedNotebookServiceClient::runtimeName()} for help formatting this field.
* @param string $diagnosticConfigGcsBucket User Cloud Storage bucket location (REQUIRED).
* Must be formatted with path prefix (`gs://$GCS_BUCKET`).
*
* Permissions:
* User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM.
* Google Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account or
* user credentials attached to VM depending on authentication mode.
*
* Cloud Storage bucket Log file will be written to
* `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
*/
function diagnose_runtime_sample(string $formattedName, string $diagnosticConfigGcsBucket): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$diagnosticConfig = (new DiagnosticConfig())
->setGcsBucket($diagnosticConfigGcsBucket);
$request = (new DiagnoseRuntimeRequest())
->setName($formattedName)
->setDiagnosticConfig($diagnosticConfig);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->diagnoseRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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 = ManagedNotebookServiceClient::runtimeName('[PROJECT]', '[LOCATION]', '[RUNTIME]');
$diagnosticConfigGcsBucket = '[GCS_BUCKET]';
diagnose_runtime_sample($formattedName, $diagnosticConfigGcsBucket);
}
getRuntime
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::getRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\GetRuntimeRequest
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\Notebooks\V1\Runtime |
use Google\ApiCore\ApiException;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\GetRuntimeRequest;
use Google\Cloud\Notebooks\V1\Runtime;
/**
* @param string $formattedName Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
* Please see {@see ManagedNotebookServiceClient::runtimeName()} for help formatting this field.
*/
function get_runtime_sample(string $formattedName): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new GetRuntimeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Runtime $response */
$response = $managedNotebookServiceClient->getRuntime($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 = ManagedNotebookServiceClient::runtimeName('[PROJECT]', '[LOCATION]', '[RUNTIME]');
get_runtime_sample($formattedName);
}
listRuntimes
Lists Runtimes in a given project and location.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::listRuntimesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\ListRuntimesRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\ListRuntimesRequest;
use Google\Cloud\Notebooks\V1\Runtime;
/**
* @param string $formattedParent Format:
* `parent=projects/{project_id}/locations/{location}`
* Please see {@see ManagedNotebookServiceClient::locationName()} for help formatting this field.
*/
function list_runtimes_sample(string $formattedParent): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new ListRuntimesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $managedNotebookServiceClient->listRuntimes($request);
/** @var Runtime $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 = ManagedNotebookServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_runtimes_sample($formattedParent);
}
refreshRuntimeTokenInternal
Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::refreshRuntimeTokenInternalAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\RefreshRuntimeTokenInternalRequest
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\Notebooks\V1\RefreshRuntimeTokenInternalResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\RefreshRuntimeTokenInternalRequest;
use Google\Cloud\Notebooks\V1\RefreshRuntimeTokenInternalResponse;
/**
* @param string $formattedName Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
* Please see {@see ManagedNotebookServiceClient::runtimeName()} for help formatting this field.
* @param string $vmId The VM hardware token for authenticating the VM.
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*/
function refresh_runtime_token_internal_sample(string $formattedName, string $vmId): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new RefreshRuntimeTokenInternalRequest())
->setName($formattedName)
->setVmId($vmId);
// Call the API and handle any network failures.
try {
/** @var RefreshRuntimeTokenInternalResponse $response */
$response = $managedNotebookServiceClient->refreshRuntimeTokenInternal($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 = ManagedNotebookServiceClient::runtimeName('[PROJECT]', '[LOCATION]', '[RUNTIME]');
$vmId = '[VM_ID]';
refresh_runtime_token_internal_sample($formattedName, $vmId);
}
reportRuntimeEvent
Report and process a runtime event.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::reportRuntimeEventAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\ReportRuntimeEventRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\Event;
use Google\Cloud\Notebooks\V1\ReportRuntimeEventRequest;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Rpc\Status;
/**
* @param string $formattedName Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
* Please see {@see ManagedNotebookServiceClient::runtimeName()} for help formatting this field.
* @param string $vmId The VM hardware token for authenticating the VM.
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*/
function report_runtime_event_sample(string $formattedName, string $vmId): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$event = new Event();
$request = (new ReportRuntimeEventRequest())
->setName($formattedName)
->setVmId($vmId)
->setEvent($event);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->reportRuntimeEvent($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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 = ManagedNotebookServiceClient::runtimeName('[PROJECT]', '[LOCATION]', '[RUNTIME]');
$vmId = '[VM_ID]';
report_runtime_event_sample($formattedName, $vmId);
}
resetRuntime
Resets a Managed Notebook Runtime.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::resetRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\ResetRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\ResetRuntimeRequest;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Rpc\Status;
/**
* @param string $name Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
function reset_runtime_sample(string $name): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new ResetRuntimeRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->resetRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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
{
$name = '[NAME]';
reset_runtime_sample($name);
}
startRuntime
Starts a Managed Notebook Runtime.
Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::startRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\StartRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Cloud\Notebooks\V1\StartRuntimeRequest;
use Google\Rpc\Status;
/**
* @param string $name Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
function start_runtime_sample(string $name): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new StartRuntimeRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->startRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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
{
$name = '[NAME]';
start_runtime_sample($name);
}
stopRuntime
Stops a Managed Notebook Runtime.
Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::stopRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\StopRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Cloud\Notebooks\V1\StopRuntimeRequest;
use Google\Rpc\Status;
/**
* @param string $name Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
function stop_runtime_sample(string $name): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new StopRuntimeRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->stopRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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
{
$name = '[NAME]';
stop_runtime_sample($name);
}
switchRuntime
Switch a Managed Notebook Runtime.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::switchRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\SwitchRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Cloud\Notebooks\V1\SwitchRuntimeRequest;
use Google\Rpc\Status;
/**
* @param string $name Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
function switch_runtime_sample(string $name): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new SwitchRuntimeRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->switchRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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
{
$name = '[NAME]';
switch_runtime_sample($name);
}
updateRuntime
Update Notebook Runtime configuration.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::updateRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\UpdateRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Cloud\Notebooks\V1\UpdateRuntimeRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* 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 update_runtime_sample(): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$runtime = new Runtime();
$updateMask = new FieldMask();
$request = (new UpdateRuntimeRequest())
->setRuntime($runtime)
->setUpdateMask($updateMask);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->updateRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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());
}
}
upgradeRuntime
Upgrades a Managed Notebook Runtime to the latest version.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::upgradeRuntimeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\UpgradeRuntimeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
use Google\Cloud\Notebooks\V1\Runtime;
use Google\Cloud\Notebooks\V1\UpgradeRuntimeRequest;
use Google\Rpc\Status;
/**
* @param string $name Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
function upgrade_runtime_sample(string $name): void
{
// Create a client.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new UpgradeRuntimeRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $managedNotebookServiceClient->upgradeRuntime($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Runtime $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
{
$name = '[NAME]';
upgrade_runtime_sample($name);
}
getLocation
Gets information about a location.
The async variant is Google\Cloud\Notebooks\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
/**
* 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.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $managedNotebookServiceClient->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\Notebooks\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
/**
* 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.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $managedNotebookServiceClient->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\Notebooks\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
/**
* @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.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $managedNotebookServiceClient->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\Notebooks\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
/**
* @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.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// 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 = $managedNotebookServiceClient->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\Notebooks\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Notebooks\V1\Client\ManagedNotebookServiceClient;
/**
* @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.
$managedNotebookServiceClient = new ManagedNotebookServiceClient();
// 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 = $managedNotebookServiceClient->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);
}
createRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\CreateRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\DeleteRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
diagnoseRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\DiagnoseRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\GetRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listRuntimesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\ListRuntimesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
refreshRuntimeTokenInternalAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\RefreshRuntimeTokenInternalRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
reportRuntimeEventAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\ReportRuntimeEventRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
resetRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\ResetRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
startRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\StartRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
stopRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\StopRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
switchRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\SwitchRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\UpdateRuntimeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
upgradeRuntimeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Notebooks\V1\UpgradeRuntimeRequest
|
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::runtimeName
Formats a string containing the fully-qualified path to represent a runtime resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
runtime |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted runtime 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}
- runtime: projects/{project}/locations/{location}/runtimes/{runtime}
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. |