Class RevisionsClient (2.28.0)

Cloud Run Revision Control Plane API.

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

RevisionsClient(RevisionsClient const &)

Copy and move support

Parameter
Name Description
RevisionsClient const &

RevisionsClient(RevisionsClient &&)

Copy and move support

Parameter
Name Description
RevisionsClient &&

RevisionsClient(std::shared_ptr< RevisionsConnection >, Options)

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

Operators

operator=(RevisionsClient const &)

Copy and move support

Parameter
Name Description
RevisionsClient const &
Returns
Type Description
RevisionsClient &

operator=(RevisionsClient &&)

Copy and move support

Parameter
Name Description
RevisionsClient &&
Returns
Type Description
RevisionsClient &

Functions

GetRevision(std::string const &, Options)

Gets information about a Revision.

Parameters
Name Description
name std::string const &

Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::run::v2::Revision >

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

GetRevision(google::cloud::run::v2::GetRevisionRequest const &, Options)

Gets information about a Revision.

Parameters
Name Description
request google::cloud::run::v2::GetRevisionRequest 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.cloud.run.v2.GetRevisionRequest. 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::cloud::run::v2::Revision >

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

ListRevisions(std::string const &, Options)

Lists Revisions from a given Service, or from a given location.

Results are sorted by creation time, descending.

Parameters
Name Description
parent std::string const &

Required. The Service from which the Revisions should be listed. To list all Revisions across Services, use "-" instead of Service name. Format: projects/{project}/locations/{location}/services/{service}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::run::v2::Revision >

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.cloud.run.v2.Revision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRevisions(google::cloud::run::v2::ListRevisionsRequest, Options)

Lists Revisions from a given Service, or from a given location.

Results are sorted by creation time, descending.

Parameters
Name Description
request google::cloud::run::v2::ListRevisionsRequest

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.cloud.run.v2.ListRevisionsRequest. 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::cloud::run::v2::Revision >

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.cloud.run.v2.Revision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteRevision(std::string const &, Options)

Deletes a Revision.

Parameters
Name Description
name std::string const &

Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::run::v2::Revision > >

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.cloud.run.v2.Revision proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRevision(NoAwaitTag, std::string const &, Options)

Deletes a Revision.

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
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteRevision(google::cloud::run::v2::DeleteRevisionRequest const &, Options)

Deletes a Revision.

Parameters
Name Description
request google::cloud::run::v2::DeleteRevisionRequest 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.cloud.run.v2.DeleteRevisionRequest. 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::cloud::run::v2::Revision > >

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.cloud.run.v2.Revision proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRevision(NoAwaitTag, google::cloud::run::v2::DeleteRevisionRequest const &, Options)

Deletes a Revision.

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::cloud::run::v2::DeleteRevisionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a Revision.

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::cloud::run::v2::Revision > >