com.google.api.services.mybusinessbusinessinformation.v1

Class MyBusinessBusinessInformation.Chains.Search

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.mybusinessbusinessinformation.v1.MyBusinessBusinessInformationRequest<SearchChainsResponse>

com.google.api.services.mybusinessbusinessinformation.v1.MyBusinessBusinessInformation.Chains.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

MyBusinessBusinessInformation.Chains

public class MyBusinessBusinessInformation.Chains.Search
extends MyBusinessBusinessInformationRequest<SearchChainsResponse>

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	Search() Searches the chain based on chain name.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getChainName() Required.
Integer	getPageSize() The maximum number of matched chains to return from this query.
MyBusinessBusinessInformation.Chains.Search	set(String parameterName, Object value)
MyBusinessBusinessInformation.Chains.Search	set$Xgafv(String $Xgafv) V1 error format.
MyBusinessBusinessInformation.Chains.Search	setAccessToken(String accessToken) OAuth access token.
MyBusinessBusinessInformation.Chains.Search	setAlt(String alt) Data format for response.
MyBusinessBusinessInformation.Chains.Search	setCallback(String callback) JSONP
MyBusinessBusinessInformation.Chains.Search	setChainName(String chainName) Required.
MyBusinessBusinessInformation.Chains.Search	setFields(String fields) Selector specifying which fields to include in a partial response.
MyBusinessBusinessInformation.Chains.Search	setKey(String key) API key.
MyBusinessBusinessInformation.Chains.Search	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
MyBusinessBusinessInformation.Chains.Search	setPageSize(Integer pageSize) The maximum number of matched chains to return from this query.
MyBusinessBusinessInformation.Chains.Search	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
MyBusinessBusinessInformation.Chains.Search	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
MyBusinessBusinessInformation.Chains.Search	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
MyBusinessBusinessInformation.Chains.Search	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.mybusinessbusinessinformation.v1.MyBusinessBusinessInformationRequest

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

Search

protected Search()

Searches the chain based on chain name. Create a request for the method "chains.search". This request holds the parameters needed by the the mybusinessbusinessinformation server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

MyBusinessBusinessInformation.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 IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchChainsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchChainsResponse>

Throws:

IOException

set$Xgafv

public MyBusinessBusinessInformation.Chains.Search set$Xgafv(String $Xgafv)

Description copied from class: MyBusinessBusinessInformationRequest

V1 error format.

Overrides:

set$Xgafv in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setAccessToken

public MyBusinessBusinessInformation.Chains.Search setAccessToken(String accessToken)

Description copied from class: MyBusinessBusinessInformationRequest

OAuth access token.

Overrides:

setAccessToken in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setAlt

public MyBusinessBusinessInformation.Chains.Search setAlt(String alt)

Description copied from class: MyBusinessBusinessInformationRequest

Data format for response.

Overrides:

setAlt in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setCallback

public MyBusinessBusinessInformation.Chains.Search setCallback(String callback)

Description copied from class: MyBusinessBusinessInformationRequest

JSONP

Overrides:

setCallback in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setFields

public MyBusinessBusinessInformation.Chains.Search setFields(String fields)

Description copied from class: MyBusinessBusinessInformationRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setKey

public MyBusinessBusinessInformation.Chains.Search setKey(String key)

Description copied from class: MyBusinessBusinessInformationRequest

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 MyBusinessBusinessInformationRequest<SearchChainsResponse>

setOauthToken

public MyBusinessBusinessInformation.Chains.Search setOauthToken(String oauthToken)

Description copied from class: MyBusinessBusinessInformationRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setPrettyPrint

public MyBusinessBusinessInformation.Chains.Search setPrettyPrint(Boolean prettyPrint)

Description copied from class: MyBusinessBusinessInformationRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setQuotaUser

public MyBusinessBusinessInformation.Chains.Search setQuotaUser(String quotaUser)

Description copied from class: MyBusinessBusinessInformationRequest

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 MyBusinessBusinessInformationRequest<SearchChainsResponse>

setUploadType

public MyBusinessBusinessInformation.Chains.Search setUploadType(String uploadType)

Description copied from class: MyBusinessBusinessInformationRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

setUploadProtocol

public MyBusinessBusinessInformation.Chains.Search setUploadProtocol(String uploadProtocol)

Description copied from class: MyBusinessBusinessInformationRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class MyBusinessBusinessInformationRequest<SearchChainsResponse>

getChainName

public String getChainName()

Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"

setChainName

public MyBusinessBusinessInformation.Chains.Search setChainName(String chainName)

Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"

getPageSize

public Integer getPageSize()

The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.

setPageSize

public MyBusinessBusinessInformation.Chains.Search setPageSize(Integer pageSize)

The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.

set

public MyBusinessBusinessInformation.Chains.Search set(String parameterName,
                                                       Object value)

Overrides:

set in class MyBusinessBusinessInformationRequest<SearchChainsResponse>