com.google.api.services.classroom

Class Classroom.UserProfiles.Guardians.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.classroom.ClassroomRequest<ListGuardiansResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Classroom.UserProfiles.Guardians

public class Classroom.UserProfiles.Guardians.List
extends ClassroomRequest<ListGuardiansResponse>

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 studentId) Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getInvitedEmailAddress() Filter results by the email address that the original invitation was sent to, resulting in this guardian link.
Integer	getPageSize() Maximum number of items to return.
String	getPageToken() nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.
String	getStudentId() Filter results by the student who the guardian is linked to.
Classroom.UserProfiles.Guardians.List	set(String parameterName, Object value)
Classroom.UserProfiles.Guardians.List	set$Xgafv(String $Xgafv) V1 error format.
Classroom.UserProfiles.Guardians.List	setAccessToken(String accessToken) OAuth access token.
Classroom.UserProfiles.Guardians.List	setAlt(String alt) Data format for response.
Classroom.UserProfiles.Guardians.List	setCallback(String callback) JSONP
Classroom.UserProfiles.Guardians.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Classroom.UserProfiles.Guardians.List	setInvitedEmailAddress(String invitedEmailAddress) Filter results by the email address that the original invitation was sent to, resulting in this guardian link.
Classroom.UserProfiles.Guardians.List	setKey(String key) API key.
Classroom.UserProfiles.Guardians.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Classroom.UserProfiles.Guardians.List	setPageSize(Integer pageSize) Maximum number of items to return.
Classroom.UserProfiles.Guardians.List	setPageToken(String pageToken) nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.
Classroom.UserProfiles.Guardians.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Classroom.UserProfiles.Guardians.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Classroom.UserProfiles.Guardians.List	setStudentId(String studentId) Filter results by the student who the guardian is linked to.
Classroom.UserProfiles.Guardians.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Classroom.UserProfiles.Guardians.List	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

List

protected List(String studentId)

Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, 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`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. Create a request for the method "guardians.list". 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 - Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ListGuardiansResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListGuardiansResponse>

Throws:

IOException

set$Xgafv

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

Description copied from class: ClassroomRequest

V1 error format.

Overrides:

set$Xgafv in class ClassroomRequest<ListGuardiansResponse>

setAccessToken

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

Description copied from class: ClassroomRequest

OAuth access token.

Overrides:

setAccessToken in class ClassroomRequest<ListGuardiansResponse>

setAlt

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

Description copied from class: ClassroomRequest

Data format for response.

Overrides:

setAlt in class ClassroomRequest<ListGuardiansResponse>

setCallback

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

Description copied from class: ClassroomRequest

JSONP

Overrides:

setCallback in class ClassroomRequest<ListGuardiansResponse>

setFields

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

Description copied from class: ClassroomRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ClassroomRequest<ListGuardiansResponse>

setKey

public Classroom.UserProfiles.Guardians.List 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<ListGuardiansResponse>

setOauthToken

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

Description copied from class: ClassroomRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ClassroomRequest<ListGuardiansResponse>

setPrettyPrint

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

Description copied from class: ClassroomRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ClassroomRequest<ListGuardiansResponse>

setQuotaUser

public Classroom.UserProfiles.Guardians.List 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<ListGuardiansResponse>

setUploadType

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

Description copied from class: ClassroomRequest

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

Overrides:

setUploadType in class ClassroomRequest<ListGuardiansResponse>

setUploadProtocol

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

Description copied from class: ClassroomRequest

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

Overrides:

setUploadProtocol in class ClassroomRequest<ListGuardiansResponse>

getStudentId

public String getStudentId()

Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view.

setStudentId

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

Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view.

getInvitedEmailAddress

public String getInvitedEmailAddress()

Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.

setInvitedEmailAddress

public Classroom.UserProfiles.Guardians.List setInvitedEmailAddress(String invitedEmailAddress)

Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.

getPageSize

public Integer getPageSize()

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

setPageSize

public Classroom.UserProfiles.Guardians.List setPageSize(Integer pageSize)

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

getPageToken

public String getPageToken()

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

setPageToken

public Classroom.UserProfiles.Guardians.List setPageToken(String pageToken)

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

set

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

Overrides:

set in class ClassroomRequest<ListGuardiansResponse>