Translate.Projects.Locations.List (Cloud Translation API v3-rev20211029-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.translate.v3.TranslateRequest<ListLocationsResponse>
        
        com.google.api.services.translate.v3.Translate.Projects.Locations.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Translate.Projects.Locations
```
public class Translate.Projects.Locations.List
extends TranslateRequest<ListLocationsResponse>
```

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 name)
Lists information about the supported locations for this service.

Constructors
Modifier	Constructor and Description
`protected`	`List(String name)` Lists information about the supported locations for this service.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` A filter to narrow down results to a preferred subset.
`String`	`getName()` The resource that owns the locations collection, if applicable.
`Integer`	`getPageSize()` The maximum number of results to return.
`String`	`getPageToken()` A page token received from the `next_page_token` field in the response.
`Translate.Projects.Locations.List`	`set(String parameterName, Object value)`
`Translate.Projects.Locations.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Translate.Projects.Locations.List`	`setAccessToken(String accessToken)` OAuth access token.
`Translate.Projects.Locations.List`	`setAlt(String alt)` Data format for response.
`Translate.Projects.Locations.List`	`setCallback(String callback)` JSONP
`Translate.Projects.Locations.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Translate.Projects.Locations.List`	`setFilter(String filter)` A filter to narrow down results to a preferred subset.
`Translate.Projects.Locations.List`	`setKey(String key)` API key.
`Translate.Projects.Locations.List`	`setName(String name)` The resource that owns the locations collection, if applicable.
`Translate.Projects.Locations.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Translate.Projects.Locations.List`	`setPageSize(Integer pageSize)` The maximum number of results to return.
`Translate.Projects.Locations.List`	`setPageToken(String pageToken)` A page token received from the `next_page_token` field in the response.
`Translate.Projects.Locations.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Translate.Projects.Locations.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Translate.Projects.Locations.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Translate.Projects.Locations.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.translate.v3.TranslateRequest
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 name)
```
    Lists information about the supported locations for this service. Create a request for the method "locations.list". This request holds the parameters needed by the the translate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Translate.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - The resource that owns the locations collection, if applicable.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListLocationsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListLocationsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Translate.Projects.Locations.List set$Xgafv(String $Xgafv)
```
    Description copied from class: TranslateRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class TranslateRequest<ListLocationsResponse>
  - setAccessToken
```
public Translate.Projects.Locations.List setAccessToken(String accessToken)
```
    Description copied from class: TranslateRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class TranslateRequest<ListLocationsResponse>
  - setAlt
```
public Translate.Projects.Locations.List setAlt(String alt)
```
    Description copied from class: TranslateRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class TranslateRequest<ListLocationsResponse>
  - setCallback
```
public Translate.Projects.Locations.List setCallback(String callback)
```
    Description copied from class: TranslateRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class TranslateRequest<ListLocationsResponse>
  - setFields
```
public Translate.Projects.Locations.List setFields(String fields)
```
    Description copied from class: TranslateRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class TranslateRequest<ListLocationsResponse>
  - setKey
```
public Translate.Projects.Locations.List setKey(String key)
```
    Description copied from class: TranslateRequest
    
    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 TranslateRequest<ListLocationsResponse>
  - setOauthToken
```
public Translate.Projects.Locations.List setOauthToken(String oauthToken)
```
    Description copied from class: TranslateRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class TranslateRequest<ListLocationsResponse>
  - setPrettyPrint
```
public Translate.Projects.Locations.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: TranslateRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class TranslateRequest<ListLocationsResponse>
  - setQuotaUser
```
public Translate.Projects.Locations.List setQuotaUser(String quotaUser)
```
    Description copied from class: TranslateRequest
    
    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 TranslateRequest<ListLocationsResponse>
  - setUploadType
```
public Translate.Projects.Locations.List setUploadType(String uploadType)
```
    Description copied from class: TranslateRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class TranslateRequest<ListLocationsResponse>
  - setUploadProtocol
```
public Translate.Projects.Locations.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: TranslateRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class TranslateRequest<ListLocationsResponse>
  - getName
```
public String getName()
```
    The resource that owns the locations collection, if applicable.
  - setName
```
public Translate.Projects.Locations.List setName(String name)
```
    The resource that owns the locations collection, if applicable.
  - getFilter
```
public String getFilter()
```
    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  - setFilter
```
public Translate.Projects.Locations.List setFilter(String filter)
```
    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of results to return. If not set, the service selects a default.
  - setPageSize
```
public Translate.Projects.Locations.List setPageSize(Integer pageSize)
```
    The maximum number of results to return. If not set, the service selects a default.
  - getPageToken
```
public String getPageToken()
```
    A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
  - setPageToken
```
public Translate.Projects.Locations.List setPageToken(String pageToken)
```
    A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
  - set
```
public Translate.Projects.Locations.List set(String parameterName,
                                             Object value)
```
    Overrides:
    
    set in class TranslateRequest<ListLocationsResponse>

Class Translate.Projects.Locations.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.translate.v3.TranslateRequest

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

getName

setName

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

set