compute  v1
Public Member Functions | List of all members
google_compute_api::RoutersResource_GetNatMappingInfoMethod Class Reference

#include <compute_service.h>

Inheritance diagram for google_compute_api::RoutersResource_GetNatMappingInfoMethod:
google_compute_api::ComputeServiceBaseRequest

Public Member Functions

 RoutersResource_GetNatMappingInfoMethod (const ComputeService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &project, const absl::string_view &region, const absl::string_view &router)
 
virtual ~RoutersResource_GetNatMappingInfoMethod ()
 
void clear_filter ()
 
const string & get_filter () const
 
string * mutable_filter ()
 
void set_filter (const string &value)
 
void clear_max_results ()
 
uint32 get_max_results () const
 
void set_max_results (uint32 value)
 
void clear_order_by ()
 
const string & get_order_by () const
 
string * mutable_orderBy ()
 
void set_order_by (const string &value)
 
void clear_page_token ()
 
const string & get_page_token () const
 
string * mutable_pageToken ()
 
void set_page_token (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 (VmEndpointNatMappingsList *data)
 
- Public Member Functions inherited from google_compute_api::ComputeServiceBaseRequest
 ComputeServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~ComputeServiceBaseRequest ()
 
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_compute_api::ComputeServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the getNatMappingInfo 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.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/compute.readonly

Constructor & Destructor Documentation

◆ RoutersResource_GetNatMappingInfoMethod()

google_compute_api::RoutersResource_GetNatMappingInfoMethod::RoutersResource_GetNatMappingInfoMethod ( const ComputeService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  project,
const absl::string_view &  region,
const absl::string_view &  router 
)

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.
[in]projectProject ID for this request.
[in]regionName of the region for this request.
[in]routerName of the Router resource to query for Nat Mapping information of VM endpoints.

◆ ~RoutersResource_GetNatMappingInfoMethod()

google_compute_api::RoutersResource_GetNatMappingInfoMethod::~RoutersResource_GetNatMappingInfoMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_compute_api::RoutersResource_GetNatMappingInfoMethod::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_compute_api::ComputeServiceBaseRequest.

◆ AppendVariable()

util::Status google_compute_api::RoutersResource_GetNatMappingInfoMethod::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_compute_api::ComputeServiceBaseRequest.

◆ clear_filter()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::clear_filter ( )
inline

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

◆ clear_max_results()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::clear_max_results ( )
inline

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

◆ clear_order_by()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::clear_order_by ( )
inline

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

◆ clear_page_token()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::clear_page_token ( )
inline

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

◆ ExecuteAndParseResponse()

util::Status google_compute_api::RoutersResource_GetNatMappingInfoMethod::ExecuteAndParseResponse ( VmEndpointNatMappingsList 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_filter()

const string& google_compute_api::RoutersResource_GetNatMappingInfoMethod::get_filter ( ) const
inline

Gets the optional 'filter' attribute.

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

◆ get_max_results()

uint32 google_compute_api::RoutersResource_GetNatMappingInfoMethod::get_max_results ( ) const
inline

Gets the optional 'maxResults' attribute.

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

◆ get_order_by()

const string& google_compute_api::RoutersResource_GetNatMappingInfoMethod::get_order_by ( ) const
inline

Gets the optional 'orderBy' attribute.

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

◆ get_page_token()

const string& google_compute_api::RoutersResource_GetNatMappingInfoMethod::get_page_token ( ) const
inline

Gets the optional 'pageToken' attribute.

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

◆ mutable_filter()

string* google_compute_api::RoutersResource_GetNatMappingInfoMethod::mutable_filter ( )
inline

Gets a modifiable pointer to the optional filter' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_orderBy()

string* google_compute_api::RoutersResource_GetNatMappingInfoMethod::mutable_orderBy ( )
inline

Gets a modifiable pointer to the optional orderBy' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_pageToken()

string* google_compute_api::RoutersResource_GetNatMappingInfoMethod::mutable_pageToken ( )
inline

Gets a modifiable pointer to the optional pageToken' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_filter()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::set_filter ( const string &  value)
inline

Sets the 'filter' attribute.

Parameters
[in]valueA filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example- instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

◆ set_max_results()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::set_max_results ( uint32  value)
inline

Sets the 'maxResults' attribute.

Parameters
[in]valueThe maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).

◆ set_order_by()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::set_order_by ( const string &  value)
inline

Sets the 'orderBy' attribute.

Parameters
[in]valueSorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

◆ set_page_token()

void google_compute_api::RoutersResource_GetNatMappingInfoMethod::set_page_token ( const string &  value)
inline

Sets the 'pageToken' attribute.

Parameters
[in]valueSpecifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

The documentation for this class was generated from the following files: