RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://cloud.google.com/compute/docs/api/using-libraries below:

Using client libraries | Compute Engine Documentation

Skip to main content Using client libraries

Stay organized with collections Save and categorize content based on your preferences.

This document demonstrates how to use Cloud Client Libraries for Compute Engine. It describes how to list, create, and delete virtual machine (VM) instances. It also describes how to check the status of a long-running operation. You can run code samples from your local machine or on a VM instance, provided that you have authorized the sample correctly.

For a full list of available client libraries, including other client libraries and third-party open source libraries, see Compute Engine Client Libraries.

Costs

In this document, you use the following billable components of Google Cloud:

Compute Engine

To generate a cost estimate based on your projected usage, use the pricing calculator.

New Google Cloud users might be eligible for a

free trial

Before you begin

Before you begin, follow the installation and authentication setup steps on Compute Engine Client Libraries for the client library you want to use.

The examples in this document require you to provide information about the VM you want to create, like its location, machine type, and source image. For details on those values, see the following documents:

Creating an instance

The following example defines an instance that uses a specified name, machine type, network, source image, and disk. Then, it creates (inserts) the instance in a project and zone that you provide. In this example, the instance connects to the default network, which is created automatically for every project. You receive a message back when the API successfully creates the instance.

When you create a virtual machine (VM) instance, you must also attach a boot disk to the VM. The boot disk contains all of the necessary files required for starting a VM, including a public or custom OS image.

C# Go Java Node.js PHP Python Ruby Listing instances

The following examples list instances in a project, either in one zone or across all zones:

You can also get a list of instances across all zones in your project:

Java

You can also get a list of instances across all zones in your project:

Node.js

You can also get a list of instances across all zones in your project:

PHP

You can also get a list of instances across all zones in your project:

Python

You can also get a list of instances across all zones in your project:

Ruby

You can also get a list of instances across all zones in your project:

Deleting an instance

The following example deletes an instance based on the project, zone, and instance name that you provide. You receive a message back when the API successfully deletes the instance.

The delete operation is irreversible. When you only want to turn off an instance temporarily, consider stopping or suspending the instance instead.

If the autoDelete parameter is true for the instance, you also delete the boot disk when you delete the instance. This setting is set to true by default during instance creation, and you can adjust it when your use case calls for disks and instances to be deleted separately.

C# Go Java Node.js PHP Python Ruby Checking operation status

Requests to the Compute Engine API that modify resources such as instances immediately return a response acknowledging your request. The acknowledgement includes information about the status of the requested operation.

Depending on the nature of the operation, it can take some time to complete. The following example waits until an operation completes before continuing code execution:

C# Go Java Node.js PHP Python Ruby Handling default values

For some fields that you choose not to send in requests or don't receive in responses, the Compute Engine API assumes non-zero default values. Google specifies these default values in API reference field descriptions and in the comments of the protocol buffers that the client libraries are built on.

These protocol buffers are in protocol buffers v3 format and report a zero value for fields that aren't present, even when the Compute Engine API server uses a different default. Zero values for fields that aren't present are as follows: 0 for numbers, false for booleans, empty for strings.

In the protocol buffers that the Compute Engine Cloud Client Libraries are built on, all non-required fields are marked as proto3 optional. Consider a field named name marked as optional in a hypothetical protocol buffer message named MyRecord. For that field, do the following:

When sending a request: If you intend to send an explicit zero value to the server for the field, you must set it in the request message: MyRecord.name="". Otherwise, the server uses its default value. Before you make the request to the server, you can confirm based on field presence that you set the zero value in your code. A field is present when something like the hypothetical MyRecord.hasName() method returns true.
When handling a response: If a field marked as optional is absent or has an explicit zero value, check the API reference to see what value you should assume for the field. For some fields, a zero value in the response is a valid non-default value and represents the intended value of the field.

In general, check the API reference documentation to see how the server interprets an absent value or zero value for a field, as it varies by method.

For example, consider changing the prefix of the name of the usage report (reportNamePrefix) for your project. When the server receives an empty string value or doesn't receive the field at all, it uses a certain default value (usage_gce, as described in the reference for projects.setUsageExportBucket) to generate the report.

Although the server explicitly returns an empty string for reportNamePrefix, the reference for projects.get correctly indicates that the report is generated with the default value usage_gce for reportNamePrefix.