Spanner.Scans.List (Cloud Spanner API v1-rev20250708-2.0.0)

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.spanner.v1.SpannerRequest<ListScansResponse>
        
        com.google.api.services.spanner.v1.Spanner.Scans.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Scans
```
public class Spanner.Scans.List
extends SpannerRequest<ListScansResponse>
```

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
  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
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String parent)
Return available scans given a Database-specific resource name.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Return available scans given a Database-specific resource name.

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()`
`String`	`getFilter()` A filter expression to restrict the results based on information present in the available Scan collection.
`Integer`	`getPageSize()` The maximum number of items to return.
`String`	`getPageToken()` The next_page_token value returned from a previous List request, if any.
`String`	`getParent()` Required.
`String`	`getView()` Specifies which parts of the Scan should be returned in the response.
`Spanner.Scans.List`	`set(String parameterName, Object value)`
`Spanner.Scans.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Spanner.Scans.List`	`setAccessToken(String accessToken)` OAuth access token.
`Spanner.Scans.List`	`setAlt(String alt)` Data format for response.
`Spanner.Scans.List`	`setCallback(String callback)` JSONP
`Spanner.Scans.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Spanner.Scans.List`	`setFilter(String filter)` A filter expression to restrict the results based on information present in the available Scan collection.
`Spanner.Scans.List`	`setKey(String key)` API key.
`Spanner.Scans.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Spanner.Scans.List`	`setPageSize(Integer pageSize)` The maximum number of items to return.
`Spanner.Scans.List`	`setPageToken(String pageToken)` The next_page_token value returned from a previous List request, if any.
`Spanner.Scans.List`	`setParent(String parent)` Required.
`Spanner.Scans.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Spanner.Scans.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Spanner.Scans.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Spanner.Scans.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Spanner.Scans.List`	`setView(String view)` Specifies which parts of the Scan should be returned in the response.

Methods inherited from class com.google.api.services.spanner.v1.SpannerRequest
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.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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 parent)
```
    Return available scans given a Database-specific resource name. Create a request for the method "scans.list". This request holds the parameters needed by the the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Spanner.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. The unique name of the parent resource, specific to the Database service implementing this interface.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListScansResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListScansResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Spanner.Scans.List set$Xgafv(String $Xgafv)
```
    Description copied from class: SpannerRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class SpannerRequest<ListScansResponse>
  - setAccessToken
```
public Spanner.Scans.List setAccessToken(String accessToken)
```
    Description copied from class: SpannerRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class SpannerRequest<ListScansResponse>
  - setAlt
```
public Spanner.Scans.List setAlt(String alt)
```
    Description copied from class: SpannerRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class SpannerRequest<ListScansResponse>
  - setCallback
```
public Spanner.Scans.List setCallback(String callback)
```
    Description copied from class: SpannerRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class SpannerRequest<ListScansResponse>
  - setFields
```
public Spanner.Scans.List setFields(String fields)
```
    Description copied from class: SpannerRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class SpannerRequest<ListScansResponse>
  - setKey
```
public Spanner.Scans.List setKey(String key)
```
    Description copied from class: SpannerRequest
    
    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 SpannerRequest<ListScansResponse>
  - setOauthToken
```
public Spanner.Scans.List setOauthToken(String oauthToken)
```
    Description copied from class: SpannerRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class SpannerRequest<ListScansResponse>
  - setPrettyPrint
```
public Spanner.Scans.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: SpannerRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class SpannerRequest<ListScansResponse>
  - setQuotaUser
```
public Spanner.Scans.List setQuotaUser(String quotaUser)
```
    Description copied from class: SpannerRequest
    
    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 SpannerRequest<ListScansResponse>
  - setUploadType
```
public Spanner.Scans.List setUploadType(String uploadType)
```
    Description copied from class: SpannerRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class SpannerRequest<ListScansResponse>
  - setUploadProtocol
```
public Spanner.Scans.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: SpannerRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class SpannerRequest<ListScansResponse>
  - getParent
```
public String getParent()
```
    Required. The unique name of the parent resource, specific to the Database service implementing this interface.
  - setParent
```
public Spanner.Scans.List setParent(String parent)
```
    Required. The unique name of the parent resource, specific to the Database service implementing this interface.
  - getFilter
```
public String getFilter()
```
    A filter expression to restrict the results based on information present in the available Scan collection. The filter applies to all fields within the Scan message except for `data`.
  - setFilter
```
public Spanner.Scans.List setFilter(String filter)
```
    A filter expression to restrict the results based on information present in the available Scan collection. The filter applies to all fields within the Scan message except for `data`.
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of items to return.
  - setPageSize
```
public Spanner.Scans.List setPageSize(Integer pageSize)
```
    The maximum number of items to return.
  - getPageToken
```
public String getPageToken()
```
    The next_page_token value returned from a previous List request, if any.
  - setPageToken
```
public Spanner.Scans.List setPageToken(String pageToken)
```
    The next_page_token value returned from a previous List request, if any.
  - getView
```
public String getView()
```
    Specifies which parts of the Scan should be returned in the response. Note, only the SUMMARY view (the default) is currently supported for ListScans.
  - setView
```
public Spanner.Scans.List setView(String view)
```
    Specifies which parts of the Scan should be returned in the response. Note, only the SUMMARY view (the default) is currently supported for ListScans.
  - set
```
public Spanner.Scans.List set(String parameterName,
                              Object value)
```
    Overrides:
    
    set in class SpannerRequest<ListScansResponse>

Class Spanner.Scans.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.spanner.v1.SpannerRequest

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

getParent

setParent

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

getView

setView

set