CloudSearch.Stats.GetSession (Cloud Search API v1 (Rev. 47) 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.cloudsearch.v1.CloudSearchRequest<GetCustomerSessionStatsResponse>
        
        com.google.api.services.cloudsearch.v1.CloudSearch.Stats.GetSession

All Implemented Interfaces:

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

Enclosing class:

CloudSearch.Stats
```
public class CloudSearch.Stats.GetSession
extends CloudSearchRequest<GetCustomerSessionStatsResponse>
```

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 GetSession()
Get the # of search sessions, % of successful sessions with a click query statistics for customer.

Constructors
Modifier	Constructor and Description
`protected`	`GetSession()` Get the # of search sessions, % of successful sessions with a click query statistics for customer.

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.lang.Integer`	`getFromDateDay()` Day of month.
`java.lang.Integer`	`getFromDateMonth()` Month of date.
`java.lang.Integer`	`getFromDateYear()` Year of date.
`java.lang.Integer`	`getToDateDay()` Day of month.
`java.lang.Integer`	`getToDateMonth()` Month of date.
`java.lang.Integer`	`getToDateYear()` Year of date.
`CloudSearch.Stats.GetSession`	`set(java.lang.String parameterName, java.lang.Object value)`
`CloudSearch.Stats.GetSession`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`CloudSearch.Stats.GetSession`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`CloudSearch.Stats.GetSession`	`setAlt(java.lang.String alt)` Data format for response.
`CloudSearch.Stats.GetSession`	`setCallback(java.lang.String callback)` JSONP
`CloudSearch.Stats.GetSession`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`CloudSearch.Stats.GetSession`	`setFromDateDay(java.lang.Integer fromDateDay)` Day of month.
`CloudSearch.Stats.GetSession`	`setFromDateMonth(java.lang.Integer fromDateMonth)` Month of date.
`CloudSearch.Stats.GetSession`	`setFromDateYear(java.lang.Integer fromDateYear)` Year of date.
`CloudSearch.Stats.GetSession`	`setKey(java.lang.String key)` API key.
`CloudSearch.Stats.GetSession`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`CloudSearch.Stats.GetSession`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudSearch.Stats.GetSession`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudSearch.Stats.GetSession`	`setToDateDay(java.lang.Integer toDateDay)` Day of month.
`CloudSearch.Stats.GetSession`	`setToDateMonth(java.lang.Integer toDateMonth)` Month of date.
`CloudSearch.Stats.GetSession`	`setToDateYear(java.lang.Integer toDateYear)` Year of date.
`CloudSearch.Stats.GetSession`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`CloudSearch.Stats.GetSession`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudsearch.v1.CloudSearchRequest
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, 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
  - GetSession
```
protected GetSession()
```
    Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute. Create a request for the method "stats.getSession". This request holds the parameters needed by the the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudSearch.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 com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetCustomerSessionStatsResponse>
    
    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<GetCustomerSessionStatsResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public CloudSearch.Stats.GetSession set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: CloudSearchRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setAccessToken
```
public CloudSearch.Stats.GetSession setAccessToken(java.lang.String accessToken)
```
    Description copied from class: CloudSearchRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setAlt
```
public CloudSearch.Stats.GetSession setAlt(java.lang.String alt)
```
    Description copied from class: CloudSearchRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setCallback
```
public CloudSearch.Stats.GetSession setCallback(java.lang.String callback)
```
    Description copied from class: CloudSearchRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setFields
```
public CloudSearch.Stats.GetSession setFields(java.lang.String fields)
```
    Description copied from class: CloudSearchRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setKey
```
public CloudSearch.Stats.GetSession setKey(java.lang.String key)
```
    Description copied from class: CloudSearchRequest
    
    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 CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setOauthToken
```
public CloudSearch.Stats.GetSession setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: CloudSearchRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setPrettyPrint
```
public CloudSearch.Stats.GetSession setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: CloudSearchRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setQuotaUser
```
public CloudSearch.Stats.GetSession setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: CloudSearchRequest
    
    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 CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setUploadType
```
public CloudSearch.Stats.GetSession setUploadType(java.lang.String uploadType)
```
    Description copied from class: CloudSearchRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - setUploadProtocol
```
public CloudSearch.Stats.GetSession setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: CloudSearchRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudSearchRequest<GetCustomerSessionStatsResponse>
  - getToDateMonth
```
public java.lang.Integer getToDateMonth()
```
    Month of date. Must be from 1 to 12.
  - setToDateMonth
```
public CloudSearch.Stats.GetSession setToDateMonth(java.lang.Integer toDateMonth)
```
    Month of date. Must be from 1 to 12.
  - getToDateYear
```
public java.lang.Integer getToDateYear()
```
    Year of date. Must be from 1 to 9999.
  - setToDateYear
```
public CloudSearch.Stats.GetSession setToDateYear(java.lang.Integer toDateYear)
```
    Year of date. Must be from 1 to 9999.
  - getFromDateMonth
```
public java.lang.Integer getFromDateMonth()
```
    Month of date. Must be from 1 to 12.
  - setFromDateMonth
```
public CloudSearch.Stats.GetSession setFromDateMonth(java.lang.Integer fromDateMonth)
```
    Month of date. Must be from 1 to 12.
  - getFromDateDay
```
public java.lang.Integer getFromDateDay()
```
    Day of month. Must be from 1 to 31 and valid for the year and month.
  - setFromDateDay
```
public CloudSearch.Stats.GetSession setFromDateDay(java.lang.Integer fromDateDay)
```
    Day of month. Must be from 1 to 31 and valid for the year and month.
  - getFromDateYear
```
public java.lang.Integer getFromDateYear()
```
    Year of date. Must be from 1 to 9999.
  - setFromDateYear
```
public CloudSearch.Stats.GetSession setFromDateYear(java.lang.Integer fromDateYear)
```
    Year of date. Must be from 1 to 9999.
  - getToDateDay
```
public java.lang.Integer getToDateDay()
```
    Day of month. Must be from 1 to 31 and valid for the year and month.
  - setToDateDay
```
public CloudSearch.Stats.GetSession setToDateDay(java.lang.Integer toDateDay)
```
    Day of month. Must be from 1 to 31 and valid for the year and month.
  - set
```
public CloudSearch.Stats.GetSession set(java.lang.String parameterName,
                                        java.lang.Object value)
```
    Overrides:
    
    set in class CloudSearchRequest<GetCustomerSessionStatsResponse>

Cloud Search API v1 (revision 47)

Class CloudSearch.Stats.GetSession

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.cloudsearch.v1.CloudSearchRequest

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

GetSession

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getToDateMonth

setToDateMonth

getToDateYear

setToDateYear

getFromDateMonth

setFromDateMonth

getFromDateDay

setFromDateDay

getFromDateYear

setFromDateYear

getToDateDay

setToDateDay

set