class Google::Apis::ClassroomV1beta1::Course
A Course in Classroom.
Attributes
State of the course. If unspecified, the default state will be `PROVISIONED`. Corresponds to the JSON property `courseState` @return [String]
Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only. Corresponds to the JSON property `creationTime` @return [String]
Optional description. For example, “We'll be learning about 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. Corresponds to the JSON property `description` @return [String]
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. Corresponds to the JSON property `descriptionHeading` @return [String]
Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only. Corresponds to the JSON property `enrollmentCode` @return [String]
Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string] as part of [creating a course], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error. Corresponds to the JSON property `id` @return [String]
Name of the course. For example, “10th Grade Biology”. This is required and must be between 1 and 750 characters and a valid UTF-8 string. Corresponds to the JSON property `name` @return [String]
The identifier of the primary teacher of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the teacher. The following aliases are supported: * the e-mail address of the user * the string literal `“me”`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error. Corresponds to the JSON property `primaryTeacherId` @return [String]
Optional room location. For example, “301” If set, this field must be a valid UTF-8 string and no longer than 650 characters. Corresponds to the JSON property `room` @return [String]
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. Corresponds to the JSON property `section` @return [String]
Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only. Corresponds to the JSON property `updateTime` @return [String]
Absolute link to this course in the Classroom web UI. Read-only. Corresponds to the JSON property `webLink` @return [String]
Public Class Methods
# File generated/google/apis/classroom_v1beta1/classes.rb, line 110 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File generated/google/apis/classroom_v1beta1/classes.rb, line 115 def update!(**args) @id = args[:id] unless args[:id].nil? @name = args[:name] unless args[:name].nil? @section = args[:section] unless args[:section].nil? @description_heading = args[:description_heading] unless args[:description_heading].nil? @description = args[:description] unless args[:description].nil? @room = args[:room] unless args[:room].nil? @primary_teacher_id = args[:primary_teacher_id] unless args[:primary_teacher_id].nil? @creation_time = args[:creation_time] unless args[:creation_time].nil? @update_time = args[:update_time] unless args[:update_time].nil? @enrollment_code = args[:enrollment_code] unless args[:enrollment_code].nil? @course_state = args[:course_state] unless args[:course_state].nil? @web_link = args[:web_link] unless args[:web_link].nil? end