Classroom.Courses.Patch (Google Classroom API v1 (Rev. 393) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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<Course>
        
        com.google.api.services.classroom.Classroom.Courses.Patch

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Classroom.Courses
```
public class Classroom.Courses.Patch
extends ClassroomRequest<Course>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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(java.lang.String id, Course content)
Updates one or more fields in a course.

Constructors
Modifier	Constructor and Description
`protected`	`Patch(java.lang.String id, Course content)` Updates one or more fields in a course.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getId()` Identifier of the course to update.
`java.lang.String`	`getUpdateMask()` Mask that identifies which fields on the course to update.
`Classroom.Courses.Patch`	`set(java.lang.String parameterName, java.lang.Object value)`
`Classroom.Courses.Patch`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Classroom.Courses.Patch`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Classroom.Courses.Patch`	`setAlt(java.lang.String alt)` Data format for response.
`Classroom.Courses.Patch`	`setCallback(java.lang.String callback)` JSONP
`Classroom.Courses.Patch`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Classroom.Courses.Patch`	`setId(java.lang.String id)` Identifier of the course to update.
`Classroom.Courses.Patch`	`setKey(java.lang.String key)` API key.
`Classroom.Courses.Patch`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Classroom.Courses.Patch`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Classroom.Courses.Patch`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Classroom.Courses.Patch`	`setUpdateMask(java.lang.String updateMask)` Mask that identifies which fields on the course to update.
`Classroom.Courses.Patch`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Classroom.Courses.Patch`	`setUploadType(java.lang.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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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(java.lang.String id,
                Course content)
```
    Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable Create a request for the method "courses.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:
    
    id - Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
    
    content - the Course
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Classroom.Courses.Patch set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: ClassroomRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ClassroomRequest<Course>
  - setAccessToken
```
public Classroom.Courses.Patch setAccessToken(java.lang.String accessToken)
```
    Description copied from class: ClassroomRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ClassroomRequest<Course>
  - setAlt
```
public Classroom.Courses.Patch setAlt(java.lang.String alt)
```
    Description copied from class: ClassroomRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ClassroomRequest<Course>
  - setCallback
```
public Classroom.Courses.Patch setCallback(java.lang.String callback)
```
    Description copied from class: ClassroomRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ClassroomRequest<Course>
  - setFields
```
public Classroom.Courses.Patch setFields(java.lang.String fields)
```
    Description copied from class: ClassroomRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ClassroomRequest<Course>
  - setKey
```
public Classroom.Courses.Patch setKey(java.lang.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<Course>
  - setOauthToken
```
public Classroom.Courses.Patch setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: ClassroomRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ClassroomRequest<Course>
  - setPrettyPrint
```
public Classroom.Courses.Patch setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: ClassroomRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ClassroomRequest<Course>
  - setQuotaUser
```
public Classroom.Courses.Patch setQuotaUser(java.lang.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<Course>
  - setUploadType
```
public Classroom.Courses.Patch setUploadType(java.lang.String uploadType)
```
    Description copied from class: ClassroomRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ClassroomRequest<Course>
  - setUploadProtocol
```
public Classroom.Courses.Patch setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: ClassroomRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ClassroomRequest<Course>
  - getId
```
public java.lang.String getId()
```
    Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
  - setId
```
public Classroom.Courses.Patch setId(java.lang.String id)
```
    Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
  - getUpdateMask
```
public java.lang.String getUpdateMask()
```
    Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`
  - setUpdateMask
```
public Classroom.Courses.Patch setUpdateMask(java.lang.String updateMask)
```
    Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`
  - set
```
public Classroom.Courses.Patch set(java.lang.String parameterName,
                                   java.lang.Object value)
```
    Overrides:
    
    set in class ClassroomRequest<Course>

Google Classroom API v1 (revision 393)

Class Classroom.Courses.Patch

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

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

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Patch

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getId

setId

getUpdateMask

setUpdateMask

set