com.google.api.services.notebooks.v1

Class AIPlatformNotebooks.Projects.Locations.Environments.List

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<ListEnvironmentsResponse>

com.google.api.services.notebooks.v1.AIPlatformNotebooks.Projects.Locations.Environments.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AIPlatformNotebooks.Projects.Locations.Environments

public class AIPlatformNotebooks.Projects.Locations.Environments.List
extends AIPlatformNotebooksRequest<ListEnvironmentsResponse>

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	List(String parent) Lists environments in a project.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() Maximum return size of the list call.
String	getPageToken() A previous returned page token that can be used to continue listing from the last result.
String	getParent() Required.
AIPlatformNotebooks.Projects.Locations.Environments.List	set(String parameterName, Object value)
AIPlatformNotebooks.Projects.Locations.Environments.List	set$Xgafv(String $Xgafv) V1 error format.
AIPlatformNotebooks.Projects.Locations.Environments.List	setAccessToken(String accessToken) OAuth access token.
AIPlatformNotebooks.Projects.Locations.Environments.List	setAlt(String alt) Data format for response.
AIPlatformNotebooks.Projects.Locations.Environments.List	setCallback(String callback) JSONP
AIPlatformNotebooks.Projects.Locations.Environments.List	setFields(String fields) Selector specifying which fields to include in a partial response.
AIPlatformNotebooks.Projects.Locations.Environments.List	setKey(String key) API key.
AIPlatformNotebooks.Projects.Locations.Environments.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AIPlatformNotebooks.Projects.Locations.Environments.List	setPageSize(Integer pageSize) Maximum return size of the list call.
AIPlatformNotebooks.Projects.Locations.Environments.List	setPageToken(String pageToken) A previous returned page token that can be used to continue listing from the last result.
AIPlatformNotebooks.Projects.Locations.Environments.List	setParent(String parent) Required.
AIPlatformNotebooks.Projects.Locations.Environments.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AIPlatformNotebooks.Projects.Locations.Environments.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AIPlatformNotebooks.Projects.Locations.Environments.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AIPlatformNotebooks.Projects.Locations.Environments.List	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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

List

protected List(String parent)

Lists environments in a project. Create a request for the method "environments.list". 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:

parent - Required. Format: `projects/{project_id}/locations/{location}`

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListEnvironmentsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListEnvironmentsResponse>

Throws:

IOException

set$Xgafv

public AIPlatformNotebooks.Projects.Locations.Environments.List set$Xgafv(String $Xgafv)

Description copied from class: AIPlatformNotebooksRequest

V1 error format.

Overrides:

set$Xgafv in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setAccessToken

public AIPlatformNotebooks.Projects.Locations.Environments.List setAccessToken(String accessToken)

Description copied from class: AIPlatformNotebooksRequest

OAuth access token.

Overrides:

setAccessToken in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setAlt

public AIPlatformNotebooks.Projects.Locations.Environments.List setAlt(String alt)

Description copied from class: AIPlatformNotebooksRequest

Data format for response.

Overrides:

setAlt in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setCallback

public AIPlatformNotebooks.Projects.Locations.Environments.List setCallback(String callback)

Description copied from class: AIPlatformNotebooksRequest

JSONP

Overrides:

setCallback in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setFields

public AIPlatformNotebooks.Projects.Locations.Environments.List setFields(String fields)

Description copied from class: AIPlatformNotebooksRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setKey

public AIPlatformNotebooks.Projects.Locations.Environments.List 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<ListEnvironmentsResponse>

setOauthToken

public AIPlatformNotebooks.Projects.Locations.Environments.List setOauthToken(String oauthToken)

Description copied from class: AIPlatformNotebooksRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setPrettyPrint

public AIPlatformNotebooks.Projects.Locations.Environments.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: AIPlatformNotebooksRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setQuotaUser

public AIPlatformNotebooks.Projects.Locations.Environments.List 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<ListEnvironmentsResponse>

setUploadType

public AIPlatformNotebooks.Projects.Locations.Environments.List setUploadType(String uploadType)

Description copied from class: AIPlatformNotebooksRequest

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

Overrides:

setUploadType in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

setUploadProtocol

public AIPlatformNotebooks.Projects.Locations.Environments.List setUploadProtocol(String uploadProtocol)

Description copied from class: AIPlatformNotebooksRequest

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

Overrides:

setUploadProtocol in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>

getParent

public String getParent()

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

setParent

public AIPlatformNotebooks.Projects.Locations.Environments.List setParent(String parent)

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

getPageSize

public Integer getPageSize()

Maximum return size of the list call.

setPageSize

public AIPlatformNotebooks.Projects.Locations.Environments.List setPageSize(Integer pageSize)

Maximum return size of the list call.

getPageToken

public String getPageToken()

A previous returned page token that can be used to continue listing from the last result.

setPageToken

public AIPlatformNotebooks.Projects.Locations.Environments.List setPageToken(String pageToken)

A previous returned page token that can be used to continue listing from the last result.

set

public AIPlatformNotebooks.Projects.Locations.Environments.List set(String parameterName,
                                                                    Object value)

Overrides:

set in class AIPlatformNotebooksRequest<ListEnvironmentsResponse>