Classroom.Courses.List (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.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.classroom.ClassroomRequest<ListCoursesResponse>
        
        com.google.api.services.classroom.Classroom.Courses.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Classroom.Courses
```
public class Classroom.Courses.List
extends ClassroomRequest<ListCoursesResponse>
```

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List()
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`List<String>`	`getCourseStates()` Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
`Integer`	`getPageSize()` Maximum number of items to return.
`String`	`getPageToken()` nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.
`String`	`getStudentId()` Restricts returned courses to those having a student with the specified identifier.
`String`	`getTeacherId()` Restricts returned courses to those having a teacher with the specified identifier.
`Classroom.Courses.List`	`set(String parameterName, Object value)`
`Classroom.Courses.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Classroom.Courses.List`	`setAccessToken(String accessToken)` OAuth access token.
`Classroom.Courses.List`	`setAlt(String alt)` Data format for response.
`Classroom.Courses.List`	`setCallback(String callback)` JSONP
`Classroom.Courses.List`	`setCourseStates(List<String> courseStates)` Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
`Classroom.Courses.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Classroom.Courses.List`	`setKey(String key)` API key.
`Classroom.Courses.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Classroom.Courses.List`	`setPageSize(Integer pageSize)` Maximum number of items to return.
`Classroom.Courses.List`	`setPageToken(String pageToken)` nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.
`Classroom.Courses.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Classroom.Courses.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Classroom.Courses.List`	`setStudentId(String studentId)` Restricts returned courses to those having a student with the specified identifier.
`Classroom.Courses.List`	`setTeacherId(String teacherId)` Restricts returned courses to those having a teacher with the specified identifier.
`Classroom.Courses.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Classroom.Courses.List`	`setUploadType(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.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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
  - List
```
protected List()
```
    Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. Create a request for the method "courses.list". 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.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListCoursesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListCoursesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Classroom.Courses.List set$Xgafv(String $Xgafv)
```
    Description copied from class: ClassroomRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ClassroomRequest<ListCoursesResponse>
  - setAccessToken
```
public Classroom.Courses.List setAccessToken(String accessToken)
```
    Description copied from class: ClassroomRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ClassroomRequest<ListCoursesResponse>
  - setAlt
```
public Classroom.Courses.List setAlt(String alt)
```
    Description copied from class: ClassroomRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ClassroomRequest<ListCoursesResponse>
  - setCallback
```
public Classroom.Courses.List setCallback(String callback)
```
    Description copied from class: ClassroomRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ClassroomRequest<ListCoursesResponse>
  - setFields
```
public Classroom.Courses.List setFields(String fields)
```
    Description copied from class: ClassroomRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ClassroomRequest<ListCoursesResponse>
  - setKey
```
public Classroom.Courses.List setKey(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<ListCoursesResponse>
  - setOauthToken
```
public Classroom.Courses.List setOauthToken(String oauthToken)
```
    Description copied from class: ClassroomRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ClassroomRequest<ListCoursesResponse>
  - setPrettyPrint
```
public Classroom.Courses.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ClassroomRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ClassroomRequest<ListCoursesResponse>
  - setQuotaUser
```
public Classroom.Courses.List setQuotaUser(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<ListCoursesResponse>
  - setUploadType
```
public Classroom.Courses.List setUploadType(String uploadType)
```
    Description copied from class: ClassroomRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ClassroomRequest<ListCoursesResponse>
  - setUploadProtocol
```
public Classroom.Courses.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ClassroomRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ClassroomRequest<ListCoursesResponse>
  - getCourseStates
```
public List<String> getCourseStates()
```
    Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
  - setCourseStates
```
public Classroom.Courses.List setCourseStates(List<String> courseStates)
```
    Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
  - getPageSize
```
public Integer getPageSize()
```
    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  - setPageSize
```
public Classroom.Courses.List setPageSize(Integer pageSize)
```
    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  - getPageToken
```
public String getPageToken()
```
    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.
  - setPageToken
```
public Classroom.Courses.List setPageToken(String pageToken)
```
    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.
  - getStudentId
```
public String getStudentId()
```
    Restricts returned courses to those having a student with the specified identifier. 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
  - setStudentId
```
public Classroom.Courses.List setStudentId(String studentId)
```
    Restricts returned courses to those having a student with the specified identifier. 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
  - getTeacherId
```
public String getTeacherId()
```
    Restricts returned courses to those having a teacher with the specified identifier. 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
  - setTeacherId
```
public Classroom.Courses.List setTeacherId(String teacherId)
```
    Restricts returned courses to those having a teacher with the specified identifier. 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
  - set
```
public Classroom.Courses.List set(String parameterName,
                                  Object value)
```
    Overrides:
    
    set in class ClassroomRequest<ListCoursesResponse>

Class Classroom.Courses.List

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getCourseStates

setCourseStates

getPageSize

setPageSize

getPageToken

setPageToken

getStudentId

setStudentId

getTeacherId

setTeacherId

set