chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/classroom_v1.courses.students.html b/docs/dyn/classroom_v1.courses.students.html
index 4c4def5..b7e2fcb 100644
--- a/docs/dyn/classroom_v1.courses.students.html
+++ b/docs/dyn/classroom_v1.courses.students.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -108,30 +108,30 @@
The object takes the form of:
{ # Student in a course.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
+ "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
- "permissions": [ # Global permissions of the user. Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
- "photoUrl": "A String", # URL of user's profile photo. Read-only.
- "emailAddress": "A String", # Email address of the user. Read-only.
- "id": "A String", # Identifier of the user. Read-only.
- "name": { # Details of the user's name. # Name of the user. Read-only.
- "familyName": "A String", # The user's last name. Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
- "givenName": "A String", # The user's first name. Read-only.
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
},
- },
- "courseId": "A String", # Identifier of the course. Read-only.
- }
+ ],
+ },
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ },
+}
enrollmentCode: string, Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
x__xgafv: string, V1 error format.
@@ -143,30 +143,30 @@
An object of the form:
{ # Student in a course.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
+ "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
- "permissions": [ # Global permissions of the user. Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
- "photoUrl": "A String", # URL of user's profile photo. Read-only.
- "emailAddress": "A String", # Email address of the user. Read-only.
- "id": "A String", # Identifier of the user. Read-only.
- "name": { # Details of the user's name. # Name of the user. Read-only.
- "familyName": "A String", # The user's last name. Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
- "givenName": "A String", # The user's first name. Read-only.
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
},
- },
- "courseId": "A String", # Identifier of the course. Read-only.
- }</pre>
+ ],
+ },
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ },
+ }</pre>
</div>
<div class="method">
@@ -204,40 +204,40 @@
An object of the form:
{ # Student in a course.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
+ "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
- "permissions": [ # Global permissions of the user. Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
- "photoUrl": "A String", # URL of user's profile photo. Read-only.
- "emailAddress": "A String", # Email address of the user. Read-only.
- "id": "A String", # Identifier of the user. Read-only.
- "name": { # Details of the user's name. # Name of the user. Read-only.
- "familyName": "A String", # The user's last name. Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
- "givenName": "A String", # The user's first name. Read-only.
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
},
- },
- "courseId": "A String", # Identifier of the course. Read-only.
- }</pre>
+ ],
+ },
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
pageSize: integer, Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.
+ pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -249,30 +249,30 @@
{ # Response when listing students.
"students": [ # Students who match the list request.
{ # Student in a course.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
+ "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
- "permissions": [ # Global permissions of the user. Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
- "photoUrl": "A String", # URL of user's profile photo. Read-only.
- "emailAddress": "A String", # Email address of the user. Read-only.
- "id": "A String", # Identifier of the user. Read-only.
- "name": { # Details of the user's name. # Name of the user. Read-only.
- "familyName": "A String", # The user's last name. Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
- "givenName": "A String", # The user's first name. Read-only.
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
},
- },
- "courseId": "A String", # Identifier of the course. Read-only.
+ ],
},
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ },
+ },
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>