Class ServicesClient (2.28.0)

Version 2.28.0

• 2.31.0-rc (latest)
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Manages services of an application.

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

ServicesClient(ServicesClient const &)

Copy and move support

Parameter
Name	Description
	ServicesClient const &

ServicesClient(ServicesClient &&)

Copy and move support

Parameter
Name	Description
	ServicesClient &&

ServicesClient(std::shared_ptr< ServicesConnection >, Options)

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

Operators

operator=(ServicesClient const &)

Copy and move support

Parameter
Name	Description
	ServicesClient const &

Returns
Type	Description
ServicesClient &

operator=(ServicesClient &&)

Copy and move support

Parameter
Name	Description
	ServicesClient &&

Returns
Type	Description
ServicesClient &

Functions

ListServices(google::appengine::v1::ListServicesRequest, Options)

Lists all the services in the application.

Parameters
Name	Description
request	google::appengine::v1::ListServicesRequest 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.ListServicesRequest. 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::Service >	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.Service, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetService(google::appengine::v1::GetServiceRequest const &, Options)

Gets the current configuration of the specified service.

Parameters
Name	Description
request	google::appengine::v1::GetServiceRequest 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.GetServiceRequest. 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::Service >	the result of the RPC. The response message type (google.appengine.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateService(google::appengine::v1::UpdateServiceRequest const &, Options)

Updates the configuration of the specified service.

Parameters
Name	Description
request	google::appengine::v1::UpdateServiceRequest 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.UpdateServiceRequest. 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::Service > >	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.Service proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateService(NoAwaitTag, google::appengine::v1::UpdateServiceRequest const &, Options)

Updates the configuration of the specified service.

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::UpdateServiceRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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

Updates the configuration of the specified service.

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::Service > >

DeleteService(google::appengine::v1::DeleteServiceRequest const &, Options)

Deletes the specified service and all enclosed versions.

Parameters
Name	Description
request	google::appengine::v1::DeleteServiceRequest 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.DeleteServiceRequest. 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.

DeleteService(NoAwaitTag, google::appengine::v1::DeleteServiceRequest const &, Options)

Deletes the specified service and all enclosed versions.

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::DeleteServiceRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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

Deletes the specified service and all enclosed versions.

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 > >