civicinfo  v2
Public Member Functions | List of all members
google_civicinfo_api::DivisionsResource_SearchMethod Class Reference
Google Civic Information API Service Methods

#include <civic_info_service.h>

Inheritance diagram for google_civicinfo_api::DivisionsResource_SearchMethod:
google_civicinfo_api::CivicInfoServiceBaseRequest

Public Member Functions

 DivisionsResource_SearchMethod (const CivicInfoService *_service_, client::AuthorizationCredential *_credential_)
 
virtual ~DivisionsResource_SearchMethod ()
 
void clear_query ()
 
const string & get_query () const
 
string * mutable_query ()
 
void set_query (const string &value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (DivisionSearchResponse *data)
 
- Public Member Functions inherited from google_civicinfo_api::CivicInfoServiceBaseRequest
 CivicInfoServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~CivicInfoServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 

Additional Inherited Members

- Protected Member Functions inherited from google_civicinfo_api::CivicInfoServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the search method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

No authorization scopes are required for this method.

Constructor & Destructor Documentation

◆ DivisionsResource_SearchMethod()

google_civicinfo_api::DivisionsResource_SearchMethod::DivisionsResource_SearchMethod ( const CivicInfoService *  _service_,
client::AuthorizationCredential *  _credential_ 
)

The standard constructor takes all the required method parameters.

Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.

◆ ~DivisionsResource_SearchMethod()

google_civicinfo_api::DivisionsResource_SearchMethod::~DivisionsResource_SearchMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_civicinfo_api::DivisionsResource_SearchMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_civicinfo_api::CivicInfoServiceBaseRequest.

◆ AppendVariable()

util::Status google_civicinfo_api::DivisionsResource_SearchMethod::AppendVariable ( const StringPiece &  variable_name,
const client::UriTemplateConfig &  config,
string *  target 
)
virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters
[in]variable_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_civicinfo_api::CivicInfoServiceBaseRequest.

◆ clear_query()

void google_civicinfo_api::DivisionsResource_SearchMethod::clear_query ( )
inline

Clears the 'query' attribute so it is no longer set.

◆ ExecuteAndParseResponse()

util::Status google_civicinfo_api::DivisionsResource_SearchMethod::ExecuteAndParseResponse ( DivisionSearchResponse *  data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_query()

const string& google_civicinfo_api::DivisionsResource_SearchMethod::get_query ( ) const
inline

Gets the optional 'query' attribute.

If the value is not set then the default value will be returned.

◆ mutable_query()

string* google_civicinfo_api::DivisionsResource_SearchMethod::mutable_query ( )
inline

Gets a modifiable pointer to the optional query' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_query()

void google_civicinfo_api::DivisionsResource_SearchMethod::set_query ( const string &  value)
inline

Sets the 'query' attribute.

Parameters
[in]valueThe search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html.
The documentation for this class was generated from the following files: