com.google.api.services.classroom.model

Class Guardian

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.classroom.model.Guardian

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Guardian
extends GenericJson

Association between a student and a guardian of that student. The guardian may receive information about the student's course work.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Classroom API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
Guardian()

Method Summary

Modifier and Type	Method and Description
Guardian	clone()
String	getGuardianId() Identifier for the guardian.
UserProfile	getGuardianProfile() User profile for the guardian.
String	getInvitedEmailAddress() The email address to which the initial guardian invitation was sent.
String	getStudentId() Identifier for the student to whom the guardian relationship applies.
Guardian	set(String fieldName, Object value)
Guardian	setGuardianId(String guardianId) Identifier for the guardian.
Guardian	setGuardianProfile(UserProfile guardianProfile) User profile for the guardian.
Guardian	setInvitedEmailAddress(String invitedEmailAddress) The email address to which the initial guardian invitation was sent.
Guardian	setStudentId(String studentId) Identifier for the student to whom the guardian relationship applies.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

Guardian

public Guardian()

Method Detail

getGuardianId

public String getGuardianId()

Identifier for the guardian.

Returns:

value or null for none

setGuardianId

public Guardian setGuardianId(String guardianId)

Identifier for the guardian.

Parameters:

guardianId - guardianId or null for none

getGuardianProfile

public UserProfile getGuardianProfile()

User profile for the guardian.

Returns:

value or null for none

setGuardianProfile

public Guardian setGuardianProfile(UserProfile guardianProfile)

User profile for the guardian.

Parameters:

guardianProfile - guardianProfile or null for none

getInvitedEmailAddress

public String getInvitedEmailAddress()

The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.

Returns:

value or null for none

setInvitedEmailAddress

public Guardian setInvitedEmailAddress(String invitedEmailAddress)

The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.

Parameters:

invitedEmailAddress - invitedEmailAddress or null for none

getStudentId

public String getStudentId()

Identifier for the student to whom the guardian relationship applies.

Returns:

value or null for none

setStudentId

public Guardian setStudentId(String studentId)

Identifier for the student to whom the guardian relationship applies.

Parameters:

studentId - studentId or null for none

set

public Guardian set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public Guardian clone()

Overrides:

clone in class GenericJson