Course (Google Classroom API v1-rev20220319-1.32.1)

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.Course

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Course
extends GenericJson
```
A Course in Classroom.
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

Course()

Constructors
Constructor and Description
`Course()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Course`	`clone()`
`String`	`getAlternateLink()` Absolute link to this course in the Classroom web UI.
`String`	`getCalendarId()` The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course.
`String`	`getCourseGroupEmail()` The email address of a Google group containing all members of the course.
`List<CourseMaterialSet>`	`getCourseMaterialSets()` Sets of materials that appear on the "about" page of this course.
`String`	`getCourseState()` State of the course.
`String`	`getCreationTime()` Creation time of the course.
`String`	`getDescription()` Optional description.
`String`	`getDescriptionHeading()` Optional heading for the description.
`String`	`getEnrollmentCode()` Enrollment code to use when joining this course.
`GradebookSettings`	`getGradebookSettings()` The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to.
`Boolean`	`getGuardiansEnabled()` Whether or not guardian notifications are enabled for this course.
`String`	`getId()` Identifier for this course assigned by Classroom.
`String`	`getName()` Name of the course.
`String`	`getOwnerId()` The identifier of the owner of a course.
`String`	`getRoom()` Optional room location.
`String`	`getSection()` Section of the course.
`DriveFolder`	`getTeacherFolder()` Information about a Drive Folder that is shared with all teachers of the course.
`String`	`getTeacherGroupEmail()` The email address of a Google group containing all teachers of the course.
`String`	`getUpdateTime()` Time of the most recent update to this course.
`Course`	`set(String fieldName, Object value)`
`Course`	`setAlternateLink(String alternateLink)` Absolute link to this course in the Classroom web UI.
`Course`	`setCalendarId(String calendarId)` The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course.
`Course`	`setCourseGroupEmail(String courseGroupEmail)` The email address of a Google group containing all members of the course.
`Course`	`setCourseMaterialSets(List<CourseMaterialSet> courseMaterialSets)` Sets of materials that appear on the "about" page of this course.
`Course`	`setCourseState(String courseState)` State of the course.
`Course`	`setCreationTime(String creationTime)` Creation time of the course.
`Course`	`setDescription(String description)` Optional description.
`Course`	`setDescriptionHeading(String descriptionHeading)` Optional heading for the description.
`Course`	`setEnrollmentCode(String enrollmentCode)` Enrollment code to use when joining this course.
`Course`	`setGradebookSettings(GradebookSettings gradebookSettings)` The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to.
`Course`	`setGuardiansEnabled(Boolean guardiansEnabled)` Whether or not guardian notifications are enabled for this course.
`Course`	`setId(String id)` Identifier for this course assigned by Classroom.
`Course`	`setName(String name)` Name of the course.
`Course`	`setOwnerId(String ownerId)` The identifier of the owner of a course.
`Course`	`setRoom(String room)` Optional room location.
`Course`	`setSection(String section)` Section of the course.
`Course`	`setTeacherFolder(DriveFolder teacherFolder)` Information about a Drive Folder that is shared with all teachers of the course.
`Course`	`setTeacherGroupEmail(String teacherGroupEmail)` The email address of a Google group containing all teachers of the course.
`Course`	`setUpdateTime(String updateTime)` Time of the most recent update to this course.

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
  - Course
```
public Course()
```
- Method Detail
  - getAlternateLink
```
public String getAlternateLink()
```
    Absolute link to this course in the Classroom web UI. Read-only.
    
    Returns:
    
    value or null for none
  - setAlternateLink
```
public Course setAlternateLink(String alternateLink)
```
    Absolute link to this course in the Classroom web UI. Read-only.
    
    Parameters:
    
    alternateLink - alternateLink or null for none
  - getCalendarId
```
public String getCalendarId()
```
    The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
    
    Returns:
    
    value or null for none
  - setCalendarId
```
public Course setCalendarId(String calendarId)
```
    The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
    
    Parameters:
    
    calendarId - calendarId or null for none
  - getCourseGroupEmail
```
public String getCourseGroupEmail()
```
    The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
    
    Returns:
    
    value or null for none
  - setCourseGroupEmail
```
public Course setCourseGroupEmail(String courseGroupEmail)
```
    The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
    
    Parameters:
    
    courseGroupEmail - courseGroupEmail or null for none
  - getCourseMaterialSets
```
public List<CourseMaterialSet> getCourseMaterialSets()
```
    Sets of materials that appear on the "about" page of this course. Read-only.
    
    Returns:
    
    value or null for none
  - setCourseMaterialSets
```
public Course setCourseMaterialSets(List<CourseMaterialSet> courseMaterialSets)
```
    Sets of materials that appear on the "about" page of this course. Read-only.
    
    Parameters:
    
    courseMaterialSets - courseMaterialSets or null for none
  - getCourseState
```
public String getCourseState()
```
    State of the course. If unspecified, the default state is `PROVISIONED`.
    
    Returns:
    
    value or null for none
  - setCourseState
```
public Course setCourseState(String courseState)
```
    State of the course. If unspecified, the default state is `PROVISIONED`.
    
    Parameters:
    
    courseState - courseState or null for none
  - getCreationTime
```
public String getCreationTime()
```
    Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
    
    Returns:
    
    value or null for none
  - setCreationTime
```
public Course setCreationTime(String creationTime)
```
    Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
    
    Parameters:
    
    creationTime - creationTime or null for none
  - getDescription
```
public String getDescription()
```
    Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Course setDescription(String description)
```
    Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
    
    Parameters:
    
    description - description or null for none
  - getDescriptionHeading
```
public String getDescriptionHeading()
```
    Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
    
    Returns:
    
    value or null for none
  - setDescriptionHeading
```
public Course setDescriptionHeading(String descriptionHeading)
```
    Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
    
    Parameters:
    
    descriptionHeading - descriptionHeading or null for none
  - getEnrollmentCode
```
public String getEnrollmentCode()
```
    Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
    
    Returns:
    
    value or null for none
  - setEnrollmentCode
```
public Course setEnrollmentCode(String enrollmentCode)
```
    Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
    
    Parameters:
    
    enrollmentCode - enrollmentCode or null for none
  - getGradebookSettings
```
public GradebookSettings getGradebookSettings()
```
    The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only
    
    Returns:
    
    value or null for none
  - setGradebookSettings
```
public Course setGradebookSettings(GradebookSettings gradebookSettings)
```
    The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only
    
    Parameters:
    
    gradebookSettings - gradebookSettings or null for none
  - getGuardiansEnabled
```
public Boolean getGuardiansEnabled()
```
    Whether or not guardian notifications are enabled for this course. Read-only.
    
    Returns:
    
    value or null for none
  - setGuardiansEnabled
```
public Course setGuardiansEnabled(Boolean guardiansEnabled)
```
    Whether or not guardian notifications are enabled for this course. Read-only.
    
    Parameters:
    
    guardiansEnabled - guardiansEnabled or null for none
  - getId
```
public String getId()
```
    Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
    
    Returns:
    
    value or null for none
  - setId
```
public Course setId(String id)
```
    Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
    
    Parameters:
    
    id - id or null for none
  - getName
```
public String getName()
```
    Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
    
    Returns:
    
    value or null for none
  - setName
```
public Course setName(String name)
```
    Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
    
    Parameters:
    
    name - name or null for none
  - getOwnerId
```
public String getOwnerId()
```
    The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
    
    Returns:
    
    value or null for none
  - setOwnerId
```
public Course setOwnerId(String ownerId)
```
    The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
    
    Parameters:
    
    ownerId - ownerId or null for none
  - getRoom
```
public String getRoom()
```
    Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
    
    Returns:
    
    value or null for none
  - setRoom
```
public Course setRoom(String room)
```
    Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
    
    Parameters:
    
    room - room or null for none
  - getSection
```
public String getSection()
```
    Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
    
    Returns:
    
    value or null for none
  - setSection
```
public Course setSection(String section)
```
    Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
    
    Parameters:
    
    section - section or null for none
  - getTeacherFolder
```
public DriveFolder getTeacherFolder()
```
    Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
    
    Returns:
    
    value or null for none
  - setTeacherFolder
```
public Course setTeacherFolder(DriveFolder teacherFolder)
```
    Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
    
    Parameters:
    
    teacherFolder - teacherFolder or null for none
  - getTeacherGroupEmail
```
public String getTeacherGroupEmail()
```
    The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
    
    Returns:
    
    value or null for none
  - setTeacherGroupEmail
```
public Course setTeacherGroupEmail(String teacherGroupEmail)
```
    The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
    
    Parameters:
    
    teacherGroupEmail - teacherGroupEmail or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Course setUpdateTime(String updateTime)
```
    Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Course set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Course clone()
```
    Overrides:
    
    clone in class GenericJson

Class Course

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

Constructor Summary

Method Summary

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

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

Course

Method Detail

getAlternateLink

setAlternateLink

getCalendarId

setCalendarId

getCourseGroupEmail

setCourseGroupEmail

getCourseMaterialSets

setCourseMaterialSets

getCourseState

setCourseState

getCreationTime

setCreationTime

getDescription

setDescription

getDescriptionHeading

setDescriptionHeading

getEnrollmentCode

setEnrollmentCode

getGradebookSettings

setGradebookSettings

getGuardiansEnabled

setGuardiansEnabled

getId

setId

getName

setName

getOwnerId

setOwnerId

getRoom

setRoom

getSection

setSection

getTeacherFolder

setTeacherFolder

getTeacherGroupEmail

setTeacherGroupEmail

getUpdateTime

setUpdateTime

set

clone