You're seeing just the function compute_instances_get_serial_port_output, go back to GoogleApi.Compute.V1.Api.Instances module for more information.
Link to this function

compute_instances_get_serial_port_output(connection, project, zone, instance, optional_params \\ [], opts \\ [])

View Source


) ::
  {:ok, GoogleApi.Compute.V1.Model.SerialPortOutput.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the last 1 MB of serial port output from the specified instance.


  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server

  • project (type: String.t) - Project ID for this request.

  • zone (type: String.t) - The name of the zone for this request.

  • instance (type: String.t) - Name of the instance for this request.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.

    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.

    • :key (type: String.t) - 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.

    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.

    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.

    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.

    • :port (type: integer()) - Specifies which COM or serial port to retrieve data from.

    • :start (type: String.t) - Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to 0.

      If the output for that byte position is available, this field matches the start parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the start property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.

  • opts (type: keyword()) - Call options


  • {:ok, %GoogleApi.Compute.V1.Model.SerialPortOutput{}} on success
  • {:error, info} on failure