com.google.api.services.notebooks.v1

Class AIPlatformNotebooks.Projects.Locations.Runtimes.Stop

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.Stop

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AIPlatformNotebooks.Projects.Locations.Runtimes

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

Nested Class Summary

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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Stop(String name, StopRuntimeRequest content) Stops a Managed Notebook Runtime.

Method Summary

Modifier and Type	Method and Description
String	getName() Required.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	set(String parameterName, Object value)
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	set$Xgafv(String $Xgafv) V1 error format.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setAccessToken(String accessToken) OAuth access token.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setAlt(String alt) Data format for response.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setCallback(String callback) JSONP
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setFields(String fields) Selector specifying which fields to include in a partial response.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setKey(String key) API key.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setName(String name) Required.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	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

Stop

protected Stop(String name,
               StopRuntimeRequest content)

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 Create a request for the method "runtimes.stop". 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 - Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`

content - the StopRuntimeRequest

Since:

1.13

Method Detail

set$Xgafv

public AIPlatformNotebooks.Projects.Locations.Runtimes.Stop 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.Stop setAccessToken(String accessToken)

Description copied from class: AIPlatformNotebooksRequest

OAuth access token.

Overrides:

setAccessToken in class AIPlatformNotebooksRequest<Operation>

setAlt

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

Description copied from class: AIPlatformNotebooksRequest

Data format for response.

Overrides:

setAlt in class AIPlatformNotebooksRequest<Operation>

setCallback

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

Description copied from class: AIPlatformNotebooksRequest

JSONP

Overrides:

setCallback in class AIPlatformNotebooksRequest<Operation>

setFields

public AIPlatformNotebooks.Projects.Locations.Runtimes.Stop 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.Stop 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.Stop 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.Stop 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.Stop 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.Stop 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.Stop 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()

Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`

setName

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

Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`

set

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

Overrides:

set in class AIPlatformNotebooksRequest<Operation>