#include <compute_service.h>
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
◆ 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] | project | Project ID for this request. |
[in] | zone | The name of the zone for this request. |
[in] | instance | Name of the instance scoping this request. |
◆ ~InstancesResource_GetSerialPortOutputMethod()
google_compute_api::InstancesResource_GetSerialPortOutputMethod::~InstancesResource_GetSerialPortOutputMethod |
( |
| ) |
|
|
virtual |
◆ AppendOptionalQueryParameters()
util::Status google_compute_api::InstancesResource_GetSerialPortOutputMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ 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_name | The name of the templated variable. |
[in] | config | A pass-through parameter used for lists and maps. |
[in,out] | target | The 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] | data | Loads 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] | value | Specifies 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] | value | Returns 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: