Class RegionInstantSnapshotsClient (2.30.0-rc)

Service for the regionInstantSnapshots resource.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstantSnapshots

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

RegionInstantSnapshotsClient(RegionInstantSnapshotsClient const &)

Copy and move support

Parameter
Name Description
RegionInstantSnapshotsClient const &

RegionInstantSnapshotsClient(RegionInstantSnapshotsClient &&)

Copy and move support

Parameter
Name Description
RegionInstantSnapshotsClient &&

RegionInstantSnapshotsClient(std::shared_ptr< RegionInstantSnapshotsConnection >, Options)

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

Operators

operator=(RegionInstantSnapshotsClient const &)

Copy and move support

Parameter
Name Description
RegionInstantSnapshotsClient const &
Returns
Type Description
RegionInstantSnapshotsClient &

operator=(RegionInstantSnapshotsClient &&)

Copy and move support

Parameter
Name Description
RegionInstantSnapshotsClient &&
Returns
Type Description
RegionInstantSnapshotsClient &

Functions

DeleteInstantSnapshot(std::string const &, std::string const &, std::string const &, Options)

Deletes the specified InstantSnapshot resource.

Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstantSnapshots/delete

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The name of the region for this request.

instant_snapshot std::string const &

Name of the InstantSnapshot resource to delete.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

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.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes the specified InstantSnapshot resource.

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

Parameters
Name Description
NoAwaitTag
project std::string const &
region std::string const &
instant_snapshot std::string const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

DeleteInstantSnapshot(google::cloud::cpp::compute::region_instant_snapshots::v1::DeleteInstantSnapshotRequest const &, Options)

Deletes the specified InstantSnapshot resource.

Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstantSnapshots/delete

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::DeleteInstantSnapshotRequest 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.cpp.compute.region_instant_snapshots.v1.DeleteInstantSnapshotRequest. 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::cpp::compute::v1::Operation > >

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.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstantSnapshot(NoAwaitTag, google::cloud::cpp::compute::region_instant_snapshots::v1::DeleteInstantSnapshotRequest const &, Options)

Deletes the specified InstantSnapshot resource.

Specifying the NoAwaitTag immediately returns the [google::cloud::cpp::compute::v1::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::cpp::compute::region_instant_snapshots::v1::DeleteInstantSnapshotRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

DeleteInstantSnapshot(google::cloud::cpp::compute::v1::Operation const &, Options)

Deletes the specified InstantSnapshot resource.

This method accepts a google::cloud::cpp::compute::v1::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::cloud::cpp::compute::v1::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

GetInstantSnapshot(std::string const &, std::string const &, std::string const &, Options)

Returns the specified InstantSnapshot resource in the specified region.

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The name of the region for this request.

instant_snapshot std::string const &

Name of the InstantSnapshot resource to return.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::InstantSnapshot >

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

GetInstantSnapshot(google::cloud::cpp::compute::region_instant_snapshots::v1::GetInstantSnapshotRequest const &, Options)

Returns the specified InstantSnapshot resource in the specified region.

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::GetInstantSnapshotRequest 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.cpp.compute.region_instant_snapshots.v1.GetInstantSnapshotRequest. 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::cpp::compute::v1::InstantSnapshot >

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

GetIamPolicy(std::string const &, std::string const &, std::string const &, Options)

Gets the access control policy for a resource.

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The name of the region for this request.

resource std::string const &

Name or id of the resource for this request.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Policy >

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

GetIamPolicy(google::cloud::cpp::compute::region_instant_snapshots::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::GetIamPolicyRequest 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.cpp.compute.region_instant_snapshots.v1.GetIamPolicyRequest. 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::cpp::compute::v1::Policy >

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

InsertInstantSnapshot(std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstantSnapshot const &, Options)

Creates an instant snapshot in the specified region.

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

Name of the region for this request.

instant_snapshot_resource google::cloud::cpp::compute::v1::InstantSnapshot const &

The InstantSnapshot for this request.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

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.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InsertInstantSnapshot(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstantSnapshot const &, Options)

Creates an instant snapshot in the specified region.

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

Parameters
Name Description
NoAwaitTag
project std::string const &
region std::string const &
instant_snapshot_resource google::cloud::cpp::compute::v1::InstantSnapshot const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

InsertInstantSnapshot(google::cloud::cpp::compute::region_instant_snapshots::v1::InsertInstantSnapshotRequest const &, Options)

Creates an instant snapshot in the specified region.

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::InsertInstantSnapshotRequest 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.cpp.compute.region_instant_snapshots.v1.InsertInstantSnapshotRequest. 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::cpp::compute::v1::Operation > >

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.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InsertInstantSnapshot(NoAwaitTag, google::cloud::cpp::compute::region_instant_snapshots::v1::InsertInstantSnapshotRequest const &, Options)

Creates an instant snapshot in the specified region.

Specifying the NoAwaitTag immediately returns the [google::cloud::cpp::compute::v1::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::cpp::compute::region_instant_snapshots::v1::InsertInstantSnapshotRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

InsertInstantSnapshot(google::cloud::cpp::compute::v1::Operation const &, Options)

Creates an instant snapshot in the specified region.

This method accepts a google::cloud::cpp::compute::v1::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::cloud::cpp::compute::v1::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

ListRegionInstantSnapshots(std::string const &, std::string const &, Options)

Retrieves the list of InstantSnapshot resources contained within the specified region.

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The name of the region for this request.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::cpp::compute::v1::InstantSnapshot >

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.cpp.compute.v1.InstantSnapshot, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRegionInstantSnapshots(google::cloud::cpp::compute::region_instant_snapshots::v1::ListRegionInstantSnapshotsRequest, Options)

Retrieves the list of InstantSnapshot resources contained within the specified region.

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::ListRegionInstantSnapshotsRequest

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.cpp.compute.region_instant_snapshots.v1.ListRegionInstantSnapshotsRequest. 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::cpp::compute::v1::InstantSnapshot >

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.cpp.compute.v1.InstantSnapshot, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SetIamPolicy(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The name of the region for this request.

resource std::string const &

Name or id of the resource for this request.

region_set_policy_request_resource google::cloud::cpp::compute::v1::RegionSetPolicyRequest const &

The RegionSetPolicyRequest for this request.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Policy >

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

SetIamPolicy(google::cloud::cpp::compute::region_instant_snapshots::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::SetIamPolicyRequest 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.cpp.compute.region_instant_snapshots.v1.SetIamPolicyRequest. 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::cpp::compute::v1::Policy >

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

SetLabels(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)

Sets the labels on a instantSnapshot in the given region.

To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstantSnapshots/setLabels

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The region for this request.

resource std::string const &

Name or id of the resource for this request.

region_set_labels_request_resource google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &

The RegionSetLabelsRequest for this request.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

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.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetLabels(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)

Sets the labels on a instantSnapshot in the given region.

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

Parameters
Name Description
NoAwaitTag
project std::string const &
region std::string const &
resource std::string const &
region_set_labels_request_resource google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

SetLabels(google::cloud::cpp::compute::region_instant_snapshots::v1::SetLabelsRequest const &, Options)

Sets the labels on a instantSnapshot in the given region.

To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstantSnapshots/setLabels

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::SetLabelsRequest 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.cpp.compute.region_instant_snapshots.v1.SetLabelsRequest. 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::cpp::compute::v1::Operation > >

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.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetLabels(NoAwaitTag, google::cloud::cpp::compute::region_instant_snapshots::v1::SetLabelsRequest const &, Options)

Sets the labels on a instantSnapshot in the given region.

Specifying the NoAwaitTag immediately returns the [google::cloud::cpp::compute::v1::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::cpp::compute::region_instant_snapshots::v1::SetLabelsRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

SetLabels(google::cloud::cpp::compute::v1::Operation const &, Options)

Sets the labels on a instantSnapshot in the given region.

This method accepts a google::cloud::cpp::compute::v1::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::cloud::cpp::compute::v1::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

TestIamPermissions(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TestPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The name of the region for this request.

resource std::string const &

Name or id of the resource for this request.

test_permissions_request_resource google::cloud::cpp::compute::v1::TestPermissionsRequest const &

The TestPermissionsRequest for this request.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::TestPermissionsResponse >

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

TestIamPermissions(google::cloud::cpp::compute::region_instant_snapshots::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request google::cloud::cpp::compute::region_instant_snapshots::v1::TestIamPermissionsRequest 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.cpp.compute.region_instant_snapshots.v1.TestIamPermissionsRequest. 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::cpp::compute::v1::TestPermissionsResponse >

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