com.google.api.services.classroom

Class Classroom.UserProfiles.Guardians.Get

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.classroom.ClassroomRequest<Guardian>

com.google.api.services.classroom.Classroom.UserProfiles.Guardians.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Classroom.UserProfiles.Guardians

public class Classroom.UserProfiles.Guardians.Get
extends ClassroomRequest<Guardian>

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	Get(String studentId, String guardianId) Returns a specific guardian.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getGuardianId() The `id` field from a `Guardian`.
String	getStudentId() The student whose guardian is being requested.
Classroom.UserProfiles.Guardians.Get	set(String parameterName, Object value)
Classroom.UserProfiles.Guardians.Get	set$Xgafv(String $Xgafv) V1 error format.
Classroom.UserProfiles.Guardians.Get	setAccessToken(String accessToken) OAuth access token.
Classroom.UserProfiles.Guardians.Get	setAlt(String alt) Data format for response.
Classroom.UserProfiles.Guardians.Get	setCallback(String callback) JSONP
Classroom.UserProfiles.Guardians.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Classroom.UserProfiles.Guardians.Get	setGuardianId(String guardianId) The `id` field from a `Guardian`.
Classroom.UserProfiles.Guardians.Get	setKey(String key) API key.
Classroom.UserProfiles.Guardians.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Classroom.UserProfiles.Guardians.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Classroom.UserProfiles.Guardians.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Classroom.UserProfiles.Guardians.Get	setStudentId(String studentId) The student whose guardian is being requested.
Classroom.UserProfiles.Guardians.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Classroom.UserProfiles.Guardians.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.classroom.ClassroomRequest

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

Get

protected Get(String studentId,
              String guardianId)

Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`. Create a request for the method "guardians.get". This request holds the parameters needed by the the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

studentId - The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

guardianId - The `id` field from a `Guardian`.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Guardian>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Guardian>

Throws:

IOException

set$Xgafv

public Classroom.UserProfiles.Guardians.Get set$Xgafv(String $Xgafv)

Description copied from class: ClassroomRequest

V1 error format.

Overrides:

set$Xgafv in class ClassroomRequest<Guardian>

setAccessToken

public Classroom.UserProfiles.Guardians.Get setAccessToken(String accessToken)

Description copied from class: ClassroomRequest

OAuth access token.

Overrides:

setAccessToken in class ClassroomRequest<Guardian>

setAlt

public Classroom.UserProfiles.Guardians.Get setAlt(String alt)

Description copied from class: ClassroomRequest

Data format for response.

Overrides:

setAlt in class ClassroomRequest<Guardian>

setCallback

public Classroom.UserProfiles.Guardians.Get setCallback(String callback)

Description copied from class: ClassroomRequest

JSONP

Overrides:

setCallback in class ClassroomRequest<Guardian>

setFields

public Classroom.UserProfiles.Guardians.Get setFields(String fields)

Description copied from class: ClassroomRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ClassroomRequest<Guardian>

setKey

public Classroom.UserProfiles.Guardians.Get setKey(String key)

Description copied from class: ClassroomRequest

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 ClassroomRequest<Guardian>

setOauthToken

public Classroom.UserProfiles.Guardians.Get setOauthToken(String oauthToken)

Description copied from class: ClassroomRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ClassroomRequest<Guardian>

setPrettyPrint

public Classroom.UserProfiles.Guardians.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: ClassroomRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ClassroomRequest<Guardian>

setQuotaUser

public Classroom.UserProfiles.Guardians.Get setQuotaUser(String quotaUser)

Description copied from class: ClassroomRequest

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 ClassroomRequest<Guardian>

setUploadType

public Classroom.UserProfiles.Guardians.Get setUploadType(String uploadType)

Description copied from class: ClassroomRequest

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

Overrides:

setUploadType in class ClassroomRequest<Guardian>

setUploadProtocol

public Classroom.UserProfiles.Guardians.Get setUploadProtocol(String uploadProtocol)

Description copied from class: ClassroomRequest

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

Overrides:

setUploadProtocol in class ClassroomRequest<Guardian>

getStudentId

public String getStudentId()

The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

setStudentId

public Classroom.UserProfiles.Guardians.Get setStudentId(String studentId)

The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

getGuardianId

public String getGuardianId()

The `id` field from a `Guardian`.

setGuardianId

public Classroom.UserProfiles.Guardians.Get setGuardianId(String guardianId)

The `id` field from a `Guardian`.

set

public Classroom.UserProfiles.Guardians.Get set(String parameterName,
                                                Object value)

Overrides:

set in class ClassroomRequest<Guardian>