Class InstancesClient (2.29.0)

Manages instances of a version.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

InstancesClient(InstancesClient const &)

Copy and move support

Parameter
Name Description
InstancesClient const &

InstancesClient(InstancesClient &&)

Copy and move support

Parameter
Name Description
InstancesClient &&

InstancesClient(std::shared_ptr< InstancesConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< InstancesConnection >
opts Options

Operators

operator=(InstancesClient const &)

Copy and move support

Parameter
Name Description
InstancesClient const &
Returns
Type Description
InstancesClient &

operator=(InstancesClient &&)

Copy and move support

Parameter
Name Description
InstancesClient &&
Returns
Type Description
InstancesClient &

Functions

ListInstances(google::appengine::v1::ListInstancesRequest, Options)

Lists the instances of a version.

Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.

Parameters
Name Description
request google::appengine::v1::ListInstancesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.ListInstancesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::appengine::v1::Instance >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.appengine.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetInstance(google::appengine::v1::GetInstanceRequest const &, Options)

Gets instance information.

Parameters
Name Description
request google::appengine::v1::GetInstanceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.GetInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::appengine::v1::Instance >

the result of the RPC. The response message type (google.appengine.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteInstance(google::appengine::v1::DeleteInstanceRequest const &, Options)

Stops a running instance.

The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment).

To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch method.

Parameters
Name Description
request google::appengine::v1::DeleteInstanceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.DeleteInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::appengine::v1::OperationMetadataV1 > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.appengine.v1.OperationMetadataV1 proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstance(NoAwaitTag, google::appengine::v1::DeleteInstanceRequest const &, Options)

Stops a running instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::appengine::v1::DeleteInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteInstance(google::longrunning::Operation const &, Options)

Stops a running instance.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::appengine::v1::OperationMetadataV1 > >

DebugInstance(google::appengine::v1::DebugInstanceRequest const &, Options)

Enables debugging on a VM instance.

This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.

Only applicable for instances in App Engine flexible environment.

Parameters
Name Description
request google::appengine::v1::DebugInstanceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.DebugInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::appengine::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.appengine.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DebugInstance(NoAwaitTag, google::appengine::v1::DebugInstanceRequest const &, Options)

Enables debugging on a VM instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::appengine::v1::DebugInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DebugInstance(google::longrunning::Operation const &, Options)

Enables debugging on a VM instance.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::appengine::v1::Instance > >