Forms.FormsOperations.Responses.List (Google Forms API v1-rev20220322-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.forms.v1.FormsRequest<ListFormResponsesResponse>
        
        com.google.api.services.forms.v1.Forms.FormsOperations.Responses.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Forms.FormsOperations.Responses
```
public class Forms.FormsOperations.Responses.List
extends FormsRequest<ListFormResponsesResponse>
```

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(String formId)
List a form's responses.

Constructors
Modifier	Constructor and Description
`protected`	`List(String formId)` List a form's responses.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` Which form responses to return.
`String`	`getFormId()` Required.
`Integer`	`getPageSize()` The maximum number of responses to return.
`String`	`getPageToken()` A page token returned by a previous list response.
`Forms.FormsOperations.Responses.List`	`set(String parameterName, Object value)`
`Forms.FormsOperations.Responses.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Forms.FormsOperations.Responses.List`	`setAccessToken(String accessToken)` OAuth access token.
`Forms.FormsOperations.Responses.List`	`setAlt(String alt)` Data format for response.
`Forms.FormsOperations.Responses.List`	`setCallback(String callback)` JSONP
`Forms.FormsOperations.Responses.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Forms.FormsOperations.Responses.List`	`setFilter(String filter)` Which form responses to return.
`Forms.FormsOperations.Responses.List`	`setFormId(String formId)` Required.
`Forms.FormsOperations.Responses.List`	`setKey(String key)` API key.
`Forms.FormsOperations.Responses.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Forms.FormsOperations.Responses.List`	`setPageSize(Integer pageSize)` The maximum number of responses to return.
`Forms.FormsOperations.Responses.List`	`setPageToken(String pageToken)` A page token returned by a previous list response.
`Forms.FormsOperations.Responses.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Forms.FormsOperations.Responses.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Forms.FormsOperations.Responses.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Forms.FormsOperations.Responses.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.forms.v1.FormsRequest
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(String formId)
```
    List a form's responses. Create a request for the method "responses.list". This request holds the parameters needed by the the forms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Forms.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    formId - Required. ID of the Form whose responses to list.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListFormResponsesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListFormResponsesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Forms.FormsOperations.Responses.List set$Xgafv(String $Xgafv)
```
    Description copied from class: FormsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class FormsRequest<ListFormResponsesResponse>
  - setAccessToken
```
public Forms.FormsOperations.Responses.List setAccessToken(String accessToken)
```
    Description copied from class: FormsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class FormsRequest<ListFormResponsesResponse>
  - setAlt
```
public Forms.FormsOperations.Responses.List setAlt(String alt)
```
    Description copied from class: FormsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class FormsRequest<ListFormResponsesResponse>
  - setCallback
```
public Forms.FormsOperations.Responses.List setCallback(String callback)
```
    Description copied from class: FormsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class FormsRequest<ListFormResponsesResponse>
  - setFields
```
public Forms.FormsOperations.Responses.List setFields(String fields)
```
    Description copied from class: FormsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class FormsRequest<ListFormResponsesResponse>
  - setKey
```
public Forms.FormsOperations.Responses.List setKey(String key)
```
    Description copied from class: FormsRequest
    
    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 FormsRequest<ListFormResponsesResponse>
  - setOauthToken
```
public Forms.FormsOperations.Responses.List setOauthToken(String oauthToken)
```
    Description copied from class: FormsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class FormsRequest<ListFormResponsesResponse>
  - setPrettyPrint
```
public Forms.FormsOperations.Responses.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: FormsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class FormsRequest<ListFormResponsesResponse>
  - setQuotaUser
```
public Forms.FormsOperations.Responses.List setQuotaUser(String quotaUser)
```
    Description copied from class: FormsRequest
    
    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 FormsRequest<ListFormResponsesResponse>
  - setUploadType
```
public Forms.FormsOperations.Responses.List setUploadType(String uploadType)
```
    Description copied from class: FormsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class FormsRequest<ListFormResponsesResponse>
  - setUploadProtocol
```
public Forms.FormsOperations.Responses.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: FormsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class FormsRequest<ListFormResponsesResponse>
  - getFormId
```
public String getFormId()
```
    Required. ID of the Form whose responses to list.
  - setFormId
```
public Forms.FormsOperations.Responses.List setFormId(String formId)
```
    Required. ID of the Form whose responses to list.
  - getFilter
```
public String getFilter()
```
    Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses submitted after (but not at) timestamp *N*. * timestamp >= *N* which means to get all form responses submitted at and after timestamp *N*. For both supported filters, timestamp must be formatted in RFC3339 UTC "Zulu" format. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
  - setFilter
```
public Forms.FormsOperations.Responses.List setFilter(String filter)
```
    Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses submitted after (but not at) timestamp *N*. * timestamp >= *N* which means to get all form responses submitted at and after timestamp *N*. For both supported filters, timestamp must be formatted in RFC3339 UTC "Zulu" format. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.
  - setPageSize
```
public Forms.FormsOperations.Responses.List setPageSize(Integer pageSize)
```
    The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.
  - getPageToken
```
public String getPageToken()
```
    A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.
  - setPageToken
```
public Forms.FormsOperations.Responses.List setPageToken(String pageToken)
```
    A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.
  - set
```
public Forms.FormsOperations.Responses.List set(String parameterName,
                                                Object value)
```
    Overrides:
    
    set in class FormsRequest<ListFormResponsesResponse>

Class Forms.FormsOperations.Responses.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.forms.v1.FormsRequest

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

getFormId

setFormId

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

set