CivicInfo.Representatives.RepresentativeInfoByDivision (Google Civic Information API v2 (Rev. 42) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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.civicinfo.CivicInfoRequest<RepresentativeInfoData>
        
        com.google.api.services.civicinfo.CivicInfo.Representatives.RepresentativeInfoByDivision

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

CivicInfo.Representatives
```
public class CivicInfo.Representatives.RepresentativeInfoByDivision
extends CivicInfoRequest<RepresentativeInfoData>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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 RepresentativeInfoByDivision(java.lang.String ocdId)
Looks up representative information for a single geographic division.

Constructors
Modifier	Constructor and Description
`protected`	`RepresentativeInfoByDivision(java.lang.String ocdId)` Looks up representative information for a single geographic division.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.util.List<java.lang.String>`	`getLevels()` A list of office levels to filter by.
`java.lang.String`	`getOcdId()` The Open Civic Data division identifier of the division to look up.
`java.lang.Boolean`	`getRecursive()` If true, information about all divisions contained in the division requested will be included as well.
`java.util.List<java.lang.String>`	`getRoles()` A list of office roles to filter by.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`set(java.lang.String parameterName, java.lang.Object value)`
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setAlt(java.lang.String alt)` Data format for the response.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setKey(java.lang.String key)` API key.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setLevels(java.util.List<java.lang.String> levels)` A list of office levels to filter by.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setOcdId(java.lang.String ocdId)` The Open Civic Data division identifier of the division to look up.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setRecursive(java.lang.Boolean recursive)` If true, information about all divisions contained in the division requested will be included as well.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setRoles(java.util.List<java.lang.String> roles)` A list of office roles to filter by.
`CivicInfo.Representatives.RepresentativeInfoByDivision`	`setUserIp(java.lang.String userIp)` Deprecated.

Methods inherited from class com.google.api.services.civicinfo.CivicInfoRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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
  - RepresentativeInfoByDivision
```
protected RepresentativeInfoByDivision(java.lang.String ocdId)
```
    Looks up representative information for a single geographic division. Create a request for the method "representatives.representativeInfoByDivision". This request holds the parameters needed by the the civicinfo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    RepresentativeInfoByDivision#initialize(com.google.api.client. googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    ocdId - The Open Civic Data division identifier of the division to look up.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RepresentativeInfoData>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RepresentativeInfoData>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setAlt(java.lang.String alt)
```
    Description copied from class: CivicInfoRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class CivicInfoRequest<RepresentativeInfoData>
  - setFields
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setFields(java.lang.String fields)
```
    Description copied from class: CivicInfoRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CivicInfoRequest<RepresentativeInfoData>
  - setKey
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setKey(java.lang.String key)
```
    Description copied from class: CivicInfoRequest
    
    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 CivicInfoRequest<RepresentativeInfoData>
  - setOauthToken
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: CivicInfoRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CivicInfoRequest<RepresentativeInfoData>
  - setPrettyPrint
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: CivicInfoRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CivicInfoRequest<RepresentativeInfoData>
  - setQuotaUser
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: CivicInfoRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class CivicInfoRequest<RepresentativeInfoData>
  - setUserIp
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setUserIp(java.lang.String userIp)
```
    Description copied from class: CivicInfoRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class CivicInfoRequest<RepresentativeInfoData>
  - getOcdId
```
public java.lang.String getOcdId()
```
    The Open Civic Data division identifier of the division to look up.
  - setOcdId
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setOcdId(java.lang.String ocdId)
```
    The Open Civic Data division identifier of the division to look up.
  - getLevels
```
public java.util.List<java.lang.String> getLevels()
```
    A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.
  - setLevels
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setLevels(java.util.List<java.lang.String> levels)
```
    A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.
  - getRecursive
```
public java.lang.Boolean getRecursive()
```
    If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
  - setRecursive
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setRecursive(java.lang.Boolean recursive)
```
    If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
  - getRoles
```
public java.util.List<java.lang.String> getRoles()
```
    A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.
  - setRoles
```
public CivicInfo.Representatives.RepresentativeInfoByDivision setRoles(java.util.List<java.lang.String> roles)
```
    A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.
  - set
```
public CivicInfo.Representatives.RepresentativeInfoByDivision set(java.lang.String parameterName,
                                                                  java.lang.Object value)
```
    Overrides:
    
    set in class CivicInfoRequest<RepresentativeInfoData>

Google Civic Information API v2 (revision 42)

Class CivicInfo.Representatives.RepresentativeInfoByDivision

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.civicinfo.CivicInfoRequest

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

RepresentativeInfoByDivision

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getOcdId

setOcdId

getLevels

setLevels

getRecursive

setRecursive

getRoles

setRoles

set