class Google::Apis::ClassroomV1::Course

A Course in Classroom.

Attributes

course_state[RW]

State of the course. If unspecified, the default state is `PROVISIONED`. Corresponds to the JSON property `courseState` @return [String]

creation_time[RW]

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]

description[RW]

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. Corresponds to the JSON property `description` @return [String]

description_heading[RW]

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[RW]

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]

id[RW]

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 will result in an error. Corresponds to the JSON property `id` @return [String]

name[RW]

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. Corresponds to the JSON property `name` @return [String]

owner_id[RW]

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. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error. Corresponds to the JSON property `ownerId` @return [String]

room[RW]

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[RW]

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]

update_time[RW]

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]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/classroom_v1/classes.rb, line 109
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/classroom_v1/classes.rb, line 114
def update!(**args)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @section = args[:section] if args.key?(:section)
  @description_heading = args[:description_heading] if args.key?(:description_heading)
  @description = args[:description] if args.key?(:description)
  @room = args[:room] if args.key?(:room)
  @owner_id = args[:owner_id] if args.key?(:owner_id)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @update_time = args[:update_time] if args.key?(:update_time)
  @enrollment_code = args[:enrollment_code] if args.key?(:enrollment_code)
  @course_state = args[:course_state] if args.key?(:course_state)
  @alternate_link = args[:alternate_link] if args.key?(:alternate_link)
end