Class VersionsClient (2.34.0-rc)

Version latest

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 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 versions of a service.

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

VersionsClient(VersionsClient const &)

Copy and move support

Parameter
Name	Description
	VersionsClient const &

VersionsClient(VersionsClient &&)

Copy and move support

Parameter
Name	Description
	VersionsClient &&

VersionsClient(std::shared_ptr< VersionsConnection >, Options)

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

Operators

operator=(VersionsClient const &)

Copy and move support

Parameter
Name	Description
	VersionsClient const &

Returns
Type	Description
VersionsClient &

operator=(VersionsClient &&)

Copy and move support

Parameter
Name	Description
	VersionsClient &&

Returns
Type	Description
VersionsClient &

Functions

ListVersions(google::appengine::v1::ListVersionsRequest, Options)

Lists the versions of a service.

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

GetVersion(google::appengine::v1::GetVersionRequest const &, Options)

Gets the specified Version resource.

By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

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

CreateVersion(google::appengine::v1::CreateVersionRequest const &, Options)

Deploys code and resource files to a new version.

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

CreateVersion(NoAwaitTag, google::appengine::v1::CreateVersionRequest const &, Options)

Deploys code and resource files to a new version.

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

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

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

Deploys code and resource files to a new version.

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

UpdateVersion(google::appengine::v1::UpdateVersionRequest const &, Options)

Updates the specified Version resource.

You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:

Standard environment

• instance_class

automatic scaling in the standard environment:

• automatic_scaling.min_idle_instances
• automatic_scaling.max_idle_instances
• automaticScaling.standard_scheduler_settings.max_instances
• automaticScaling.standard_scheduler_settings.min_instances
• automaticScaling.standard_scheduler_settings.target_cpu_utilization
• automaticScaling.standard_scheduler_settings.target_throughput_utilization

basic scaling or manual scaling in the standard environment:

• serving_status
• manual_scaling.instances

Flexible environment

• serving_status

automatic scaling in the flexible environment:

• automatic_scaling.min_total_instances
• automatic_scaling.max_total_instances
• automatic_scaling.cool_down_period_sec
• automatic_scaling.cpu_utilization.target_utilization

manual scaling in the flexible environment:

• manual_scaling.instances

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

UpdateVersion(NoAwaitTag, google::appengine::v1::UpdateVersionRequest const &, Options)

Updates the specified Version resource.

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

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

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

Updates the specified Version resource.

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

DeleteVersion(google::appengine::v1::DeleteVersionRequest const &, Options)

Deletes an existing Version resource.

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

DeleteVersion(NoAwaitTag, google::appengine::v1::DeleteVersionRequest const &, Options)

Deletes an existing Version resource.

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

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

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

Deletes an existing Version resource.

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