com.google.api.services.notebooks.v1

Class AIPlatformNotebooks.Projects.Locations.Runtimes.Patch

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.notebooks.v1.AIPlatformNotebooksRequest<Operation>

com.google.api.services.notebooks.v1.AIPlatformNotebooks.Projects.Locations.Runtimes.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AIPlatformNotebooks.Projects.Locations.Runtimes

public class AIPlatformNotebooks.Projects.Locations.Runtimes.Patch
extends AIPlatformNotebooksRequest<Operation>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Patch(String name, Runtime content) Update Notebook Runtime configuration.

Method Summary

Modifier and Type	Method and Description
String	getName() Output only.
String	getRequestId() Idempotent request UUID.
String	getUpdateMask() Required.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	set(String parameterName, Object value)
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	set$Xgafv(String $Xgafv) V1 error format.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setAccessToken(String accessToken) OAuth access token.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setAlt(String alt) Data format for response.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setCallback(String callback) JSONP
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setKey(String key) API key.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setName(String name) Output only.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setRequestId(String requestId) Idempotent request UUID.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setUpdateMask(String updateMask) Required.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.notebooks.v1.AIPlatformNotebooksRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Patch

protected Patch(String name,
                Runtime content)

Update Notebook Runtime configuration. Create a request for the method "runtimes.patch". This request holds the parameters needed by the the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

AIPlatformNotebooks.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

content - the Runtime

Since:

1.13

Method Detail

set$Xgafv

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch set$Xgafv(String $Xgafv)

Description copied from class: AIPlatformNotebooksRequest

V1 error format.

Overrides:

set$Xgafv in class AIPlatformNotebooksRequest<Operation>

setAccessToken

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setAccessToken(String accessToken)

Description copied from class: AIPlatformNotebooksRequest

OAuth access token.

Overrides:

setAccessToken in class AIPlatformNotebooksRequest<Operation>

setAlt

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setAlt(String alt)

Description copied from class: AIPlatformNotebooksRequest

Data format for response.

Overrides:

setAlt in class AIPlatformNotebooksRequest<Operation>

setCallback

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setCallback(String callback)

Description copied from class: AIPlatformNotebooksRequest

JSONP

Overrides:

setCallback in class AIPlatformNotebooksRequest<Operation>

setFields

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setFields(String fields)

Description copied from class: AIPlatformNotebooksRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AIPlatformNotebooksRequest<Operation>

setKey

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setKey(String key)

Description copied from class: AIPlatformNotebooksRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class AIPlatformNotebooksRequest<Operation>

setOauthToken

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setOauthToken(String oauthToken)

Description copied from class: AIPlatformNotebooksRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AIPlatformNotebooksRequest<Operation>

setPrettyPrint

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: AIPlatformNotebooksRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AIPlatformNotebooksRequest<Operation>

setQuotaUser

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setQuotaUser(String quotaUser)

Description copied from class: AIPlatformNotebooksRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class AIPlatformNotebooksRequest<Operation>

setUploadType

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setUploadType(String uploadType)

Description copied from class: AIPlatformNotebooksRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class AIPlatformNotebooksRequest<Operation>

setUploadProtocol

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: AIPlatformNotebooksRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class AIPlatformNotebooksRequest<Operation>

getName

public String getName()

Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

setName

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setName(String name)

Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

getRequestId

public String getRequestId()

Idempotent request UUID.

setRequestId

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setRequestId(String requestId)

Idempotent request UUID.

getUpdateMask

public String getUpdateMask()

Required. Specifies the path, relative to `Runtime`, of the field to update. For example, to change the software configuration kernels, the `update_mask` parameter would be specified as `software_config.kernels`, and the `PATCH` request body would specify the new value, as follows: { "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } } Currently, only the following fields can be updated: - `software_config.kernels` - `software_config.post_startup_script` - `software_config.custom_gpu_driver_path` - `software_config.idle_shutdown` - `software_config.idle_shutdown_timeout` - `software_config.disable_terminal` - `labels`

setUpdateMask

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch setUpdateMask(String updateMask)

Required. Specifies the path, relative to `Runtime`, of the field to update. For example, to change the software configuration kernels, the `update_mask` parameter would be specified as `software_config.kernels`, and the `PATCH` request body would specify the new value, as follows: { "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } } Currently, only the following fields can be updated: - `software_config.kernels` - `software_config.post_startup_script` - `software_config.custom_gpu_driver_path` - `software_config.idle_shutdown` - `software_config.idle_shutdown_timeout` - `software_config.disable_terminal` - `labels`

set

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch set(String parameterName,
                                                                 Object value)

Overrides:

set in class AIPlatformNotebooksRequest<Operation>