com.google.api.services.classroom

Class Classroom.UserProfiles.GuardianInvitations.Patch

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

com.google.api.services.classroom.Classroom.UserProfiles.GuardianInvitations.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Classroom.UserProfiles.GuardianInvitations

public class Classroom.UserProfiles.GuardianInvitations.Patch
extends ClassroomRequest<GuardianInvitation>

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	Patch(String studentId, String invitationId, GuardianInvitation content) Modifies a guardian invitation.

Method Summary

Modifier and Type	Method and Description
String	getInvitationId() The `id` field of the `GuardianInvitation` to be modified.
String	getStudentId() The ID of the student whose guardian invitation is to be modified.
String	getUpdateMask() Mask that identifies which fields on the course to update.
Classroom.UserProfiles.GuardianInvitations.Patch	set(String parameterName, Object value)
Classroom.UserProfiles.GuardianInvitations.Patch	set$Xgafv(String $Xgafv) V1 error format.
Classroom.UserProfiles.GuardianInvitations.Patch	setAccessToken(String accessToken) OAuth access token.
Classroom.UserProfiles.GuardianInvitations.Patch	setAlt(String alt) Data format for response.
Classroom.UserProfiles.GuardianInvitations.Patch	setCallback(String callback) JSONP
Classroom.UserProfiles.GuardianInvitations.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
Classroom.UserProfiles.GuardianInvitations.Patch	setInvitationId(String invitationId) The `id` field of the `GuardianInvitation` to be modified.
Classroom.UserProfiles.GuardianInvitations.Patch	setKey(String key) API key.
Classroom.UserProfiles.GuardianInvitations.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Classroom.UserProfiles.GuardianInvitations.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Classroom.UserProfiles.GuardianInvitations.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Classroom.UserProfiles.GuardianInvitations.Patch	setStudentId(String studentId) The ID of the student whose guardian invitation is to be modified.
Classroom.UserProfiles.GuardianInvitations.Patch	setUpdateMask(String updateMask) Mask that identifies which fields on the course to update.
Classroom.UserProfiles.GuardianInvitations.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Classroom.UserProfiles.GuardianInvitations.Patch	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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Patch

protected Patch(String studentId,
                String invitationId,
                GuardianInvitation content)

Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom. Create a request for the method "guardianInvitations.patch". 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 ID of the student whose guardian invitation is to be modified.

invitationId - The `id` field of the `GuardianInvitation` to be modified.

content - the GuardianInvitation

Since:

1.13

Method Detail

set$Xgafv

public Classroom.UserProfiles.GuardianInvitations.Patch set$Xgafv(String $Xgafv)

Description copied from class: ClassroomRequest

V1 error format.

Overrides:

set$Xgafv in class ClassroomRequest<GuardianInvitation>

setAccessToken

public Classroom.UserProfiles.GuardianInvitations.Patch setAccessToken(String accessToken)

Description copied from class: ClassroomRequest

OAuth access token.

Overrides:

setAccessToken in class ClassroomRequest<GuardianInvitation>

setAlt

public Classroom.UserProfiles.GuardianInvitations.Patch setAlt(String alt)

Description copied from class: ClassroomRequest

Data format for response.

Overrides:

setAlt in class ClassroomRequest<GuardianInvitation>

setCallback

public Classroom.UserProfiles.GuardianInvitations.Patch setCallback(String callback)

Description copied from class: ClassroomRequest

JSONP

Overrides:

setCallback in class ClassroomRequest<GuardianInvitation>

setFields

public Classroom.UserProfiles.GuardianInvitations.Patch setFields(String fields)

Description copied from class: ClassroomRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ClassroomRequest<GuardianInvitation>

setKey

public Classroom.UserProfiles.GuardianInvitations.Patch 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<GuardianInvitation>

setOauthToken

public Classroom.UserProfiles.GuardianInvitations.Patch setOauthToken(String oauthToken)

Description copied from class: ClassroomRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ClassroomRequest<GuardianInvitation>

setPrettyPrint

public Classroom.UserProfiles.GuardianInvitations.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: ClassroomRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ClassroomRequest<GuardianInvitation>

setQuotaUser

public Classroom.UserProfiles.GuardianInvitations.Patch 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<GuardianInvitation>

setUploadType

public Classroom.UserProfiles.GuardianInvitations.Patch setUploadType(String uploadType)

Description copied from class: ClassroomRequest

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

Overrides:

setUploadType in class ClassroomRequest<GuardianInvitation>

setUploadProtocol

public Classroom.UserProfiles.GuardianInvitations.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: ClassroomRequest

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

Overrides:

setUploadProtocol in class ClassroomRequest<GuardianInvitation>

getStudentId

public String getStudentId()

The ID of the student whose guardian invitation is to be modified.

setStudentId

public Classroom.UserProfiles.GuardianInvitations.Patch setStudentId(String studentId)

The ID of the student whose guardian invitation is to be modified.

getInvitationId

public String getInvitationId()

The `id` field of the `GuardianInvitation` to be modified.

setInvitationId

public Classroom.UserProfiles.GuardianInvitations.Patch setInvitationId(String invitationId)

The `id` field of the `GuardianInvitation` to be modified.

getUpdateMask

public String getUpdateMask()

Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`

setUpdateMask

public Classroom.UserProfiles.GuardianInvitations.Patch setUpdateMask(String updateMask)

Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`

set

public Classroom.UserProfiles.GuardianInvitations.Patch set(String parameterName,
                                                            Object value)

Overrides:

set in class ClassroomRequest<GuardianInvitation>