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

#include <compute_service.h>

Inheritance diagram for google_compute_api::InstancesResource_GetSerialPortOutputMethod:
google_compute_api::ComputeServiceBaseRequest

Public Member Functions

 InstancesResource_GetSerialPortOutputMethod (const ComputeService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &project, const absl::string_view &zone, const absl::string_view &instance)
 
virtual ~InstancesResource_GetSerialPortOutputMethod ()
 
void clear_port ()
 
int32 get_port () const
 
void set_port (int32 value)
 
void clear_start ()
 
int64 get_start () const
 
void set_start (int64 value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (SerialPortOutput *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 getSerialPortOutput 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

◆ InstancesResource_GetSerialPortOutputMethod()

google_compute_api::InstancesResource_GetSerialPortOutputMethod::InstancesResource_GetSerialPortOutputMethod ( const ComputeService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  project,
const absl::string_view &  zone,
const absl::string_view &  instance 
)

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]zoneThe name of the zone for this request.
[in]instanceName of the instance scoping this request.

◆ ~InstancesResource_GetSerialPortOutputMethod()

google_compute_api::InstancesResource_GetSerialPortOutputMethod::~InstancesResource_GetSerialPortOutputMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_compute_api::InstancesResource_GetSerialPortOutputMethod::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::InstancesResource_GetSerialPortOutputMethod::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_port()

void google_compute_api::InstancesResource_GetSerialPortOutputMethod::clear_port ( )
inline

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

◆ clear_start()

void google_compute_api::InstancesResource_GetSerialPortOutputMethod::clear_start ( )
inline

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

◆ ExecuteAndParseResponse()

util::Status google_compute_api::InstancesResource_GetSerialPortOutputMethod::ExecuteAndParseResponse ( SerialPortOutput 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_port()

int32 google_compute_api::InstancesResource_GetSerialPortOutputMethod::get_port ( ) const
inline

Gets the optional 'port' attribute.

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

◆ get_start()

int64 google_compute_api::InstancesResource_GetSerialPortOutputMethod::get_start ( ) const
inline

Gets the optional 'start' attribute.

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

◆ set_port()

void google_compute_api::InstancesResource_GetSerialPortOutputMethod::set_port ( int32  value)
inline

Sets the 'port' attribute.

Parameters
[in]valueSpecifies which COM or serial port to retrieve data from.

◆ set_start()

void google_compute_api::InstancesResource_GetSerialPortOutputMethod::set_start ( int64  value)
inline

Sets the 'start' attribute.

Parameters
[in]valueReturns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call.

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