• Home
• com.google.apis
• google-api-services-customsearch
• v1-rev20200401-1.30.9
• source code
• CustomsearchRequest.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.customsearch.CustomsearchRequest.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.customsearch
Class CustomsearchRequest<T>



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.customsearch.CustomsearchRequest<T>















All Implemented Interfaces:
Cloneable, Map<String,Object>


Direct Known Subclasses:
Customsearch.Cse.List, Customsearch.Cse.Siterestrict.List




public abstract class CustomsearchRequest<T>
extends AbstractGoogleJsonClientRequest<T>
Customsearch request.

Since:
1.3












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 

Constructor and Description


CustomsearchRequest(Customsearch client,
                   String method,
                   String uriTemplate,
                   Object content,
                   Class<T> responseClass) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Customsearch
getAbstractGoogleClient() 


String
getAlt()
Data format for the response.



String
getFields()
Selector specifying which fields to include in a partial response.



String
getKey()
API key.



String
getOauthToken()
OAuth 2.0 token for the current user.



Boolean
getPrettyPrint()
Returns response with indentations and line breaks.



String
getQuotaUser()
An opaque string that represents a user for quota purposes.



String
getUserIp()
Deprecated.



CustomsearchRequest<T>
set(String parameterName,
   Object value) 


CustomsearchRequest<T>
setAlt(String alt)
Data format for the response.



CustomsearchRequest<T>
setDisableGZipContent(boolean disableGZipContent) 


CustomsearchRequest<T>
setFields(String fields)
Selector specifying which fields to include in a partial response.



CustomsearchRequest<T>
setKey(String key)
API key.



CustomsearchRequest<T>
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



CustomsearchRequest<T>
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



CustomsearchRequest<T>
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.



CustomsearchRequest<T>
setRequestHeaders(HttpHeaders headers) 


CustomsearchRequest<T>
setUserIp(String userIp)
Deprecated.







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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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





CustomsearchRequest
public CustomsearchRequest(Customsearch client,
                           String method,
                           String uriTemplate,
                           Object content,
                           Class<T> responseClass)

Parameters:
client - Google client
method - HTTP Method
uriTemplate - URI template for the path relative to the base URL. If it starts with a "/"
        the base path from the base URL will be stripped out. The URI template can also be a
        full URL. URI template expansion is done using
        UriTemplate.expand(String, String, Object, boolean)
content - A POJO that can be serialized into JSON or null for none
responseClass - response class to parse into










Method Detail





getAlt
public String getAlt()
Data format for the response. [default: json]







setAlt
public CustomsearchRequest<T> setAlt(String alt)
Data format for the response.







getFields
public String getFields()
Selector specifying which fields to include in a partial response.







setFields
public CustomsearchRequest<T> setFields(String fields)
Selector specifying which fields to include in a partial response.







getKey
public String getKey()
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.







setKey
public CustomsearchRequest<T> setKey(String key)
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.







getOauthToken
public String getOauthToken()
OAuth 2.0 token for the current user.







setOauthToken
public CustomsearchRequest<T> setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.







getPrettyPrint
public Boolean getPrettyPrint()
Returns response with indentations and line breaks. [default: true]







setPrettyPrint
public CustomsearchRequest<T> setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.







getQuotaUser
public String getQuotaUser()
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.







setQuotaUser
public CustomsearchRequest<T> setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.







getUserIp
public String getUserIp()
Deprecated. Please use quotaUser instead.







setUserIp
public CustomsearchRequest<T> setUserIp(String userIp)
Deprecated. Please use quotaUser instead.







getAbstractGoogleClient
public final Customsearch getAbstractGoogleClient()

Overrides:
getAbstractGoogleClient in class AbstractGoogleJsonClientRequest<T>








setDisableGZipContent
public CustomsearchRequest<T> setDisableGZipContent(boolean disableGZipContent)

Overrides:
setDisableGZipContent in class AbstractGoogleJsonClientRequest<T>








setRequestHeaders
public CustomsearchRequest<T> setRequestHeaders(HttpHeaders headers)

Overrides:
setRequestHeaders in class AbstractGoogleJsonClientRequest<T>








set
public CustomsearchRequest<T> set(String parameterName,
                                  Object value)

Overrides:
set in class AbstractGoogleJsonClientRequest<T>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.