com.google.api.services.ml.v1

Class CloudMachineLearningEngine.Projects.Locations.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.ml.v1.CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

com.google.api.services.ml.v1.CloudMachineLearningEngine.Projects.Locations.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudMachineLearningEngine.Projects.Locations

public class CloudMachineLearningEngine.Projects.Locations.List
extends CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

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	List(String parent) List all locations that provides at least one type of CMLE capability.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Integer	getPageSize() Optional.
String	getPageToken() Optional.
String	getParent() Required.
CloudMachineLearningEngine.Projects.Locations.List	set(String parameterName, Object value)
CloudMachineLearningEngine.Projects.Locations.List	set$Xgafv(String $Xgafv) V1 error format.
CloudMachineLearningEngine.Projects.Locations.List	setAccessToken(String accessToken) OAuth access token.
CloudMachineLearningEngine.Projects.Locations.List	setAlt(String alt) Data format for response.
CloudMachineLearningEngine.Projects.Locations.List	setCallback(String callback) JSONP
CloudMachineLearningEngine.Projects.Locations.List	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudMachineLearningEngine.Projects.Locations.List	setKey(String key) API key.
CloudMachineLearningEngine.Projects.Locations.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudMachineLearningEngine.Projects.Locations.List	setPageSize(Integer pageSize) Optional.
CloudMachineLearningEngine.Projects.Locations.List	setPageToken(String pageToken) Optional.
CloudMachineLearningEngine.Projects.Locations.List	setParent(String parent) Required.
CloudMachineLearningEngine.Projects.Locations.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudMachineLearningEngine.Projects.Locations.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudMachineLearningEngine.Projects.Locations.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudMachineLearningEngine.Projects.Locations.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.ml.v1.CloudMachineLearningEngineRequest

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)

List all locations that provides at least one type of CMLE capability. Create a request for the method "locations.list". This request holds the parameters needed by the the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

parent - Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<GoogleCloudMlV1ListLocationsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<GoogleCloudMlV1ListLocationsResponse>

Throws:

IOException

set$Xgafv

public CloudMachineLearningEngine.Projects.Locations.List set$Xgafv(String $Xgafv)

Description copied from class: CloudMachineLearningEngineRequest

V1 error format.

Overrides:

set$Xgafv in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setAccessToken

public CloudMachineLearningEngine.Projects.Locations.List setAccessToken(String accessToken)

Description copied from class: CloudMachineLearningEngineRequest

OAuth access token.

Overrides:

setAccessToken in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setAlt

public CloudMachineLearningEngine.Projects.Locations.List setAlt(String alt)

Description copied from class: CloudMachineLearningEngineRequest

Data format for response.

Overrides:

setAlt in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setCallback

public CloudMachineLearningEngine.Projects.Locations.List setCallback(String callback)

Description copied from class: CloudMachineLearningEngineRequest

JSONP

Overrides:

setCallback in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setFields

public CloudMachineLearningEngine.Projects.Locations.List setFields(String fields)

Description copied from class: CloudMachineLearningEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setKey

public CloudMachineLearningEngine.Projects.Locations.List setKey(String key)

Description copied from class: CloudMachineLearningEngineRequest

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 CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setOauthToken

public CloudMachineLearningEngine.Projects.Locations.List setOauthToken(String oauthToken)

Description copied from class: CloudMachineLearningEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setPrettyPrint

public CloudMachineLearningEngine.Projects.Locations.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudMachineLearningEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setQuotaUser

public CloudMachineLearningEngine.Projects.Locations.List setQuotaUser(String quotaUser)

Description copied from class: CloudMachineLearningEngineRequest

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 CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setUploadType

public CloudMachineLearningEngine.Projects.Locations.List setUploadType(String uploadType)

Description copied from class: CloudMachineLearningEngineRequest

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

Overrides:

setUploadType in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

setUploadProtocol

public CloudMachineLearningEngine.Projects.Locations.List setUploadProtocol(String uploadProtocol)

Description copied from class: CloudMachineLearningEngineRequest

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

Overrides:

setUploadProtocol in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>

getParent

public String getParent()

Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).

setParent

public CloudMachineLearningEngine.Projects.Locations.List setParent(String parent)

Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).

getPageSize

public Integer getPageSize()

Optional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.

setPageSize

public CloudMachineLearningEngine.Projects.Locations.List setPageSize(Integer pageSize)

Optional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.

getPageToken

public String getPageToken()

Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.

setPageToken

public CloudMachineLearningEngine.Projects.Locations.List setPageToken(String pageToken)

Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.

set

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

Overrides:

set in class CloudMachineLearningEngineRequest<GoogleCloudMlV1ListLocationsResponse>