Class SnapshotsClient (2.17.0)

Version 2.17.0

• 2.25.0-rc (latest)
• 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

Service for the snapshots resource.

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

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

SnapshotsClient(SnapshotsClient const &)

Copy and move support

Parameter
Name	Description
	SnapshotsClient const &

SnapshotsClient(SnapshotsClient &&)

Copy and move support

Parameter
Name	Description
	SnapshotsClient &&

SnapshotsClient(std::shared_ptr< SnapshotsConnection >, Options)

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

Operators

operator=(SnapshotsClient const &)

Copy and move support

Parameter
Name	Description
	SnapshotsClient const &

Returns
Type	Description
SnapshotsClient &

operator=(SnapshotsClient &&)

Copy and move support

Parameter
Name	Description
	SnapshotsClient &&

Returns
Type	Description
SnapshotsClient &

Functions

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

Deletes the specified Snapshot resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
snapshot	std::string const & Name of the Snapshot 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.

DeleteSnapshot(google::cloud::cpp::compute::snapshots::v1::DeleteSnapshotRequest const &, Options)

Deletes the specified Snapshot resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::snapshots::v1::DeleteSnapshotRequest 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.snapshots.v1.DeleteSnapshotRequest. 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.

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

Returns the specified Snapshot resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
snapshot	std::string const & Name of the Snapshot 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::Snapshot >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Snapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSnapshot(google::cloud::cpp::compute::snapshots::v1::GetSnapshotRequest const &, Options)

Returns the specified Snapshot resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::snapshots::v1::GetSnapshotRequest 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.snapshots.v1.GetSnapshotRequest. 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::Snapshot >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Snapshot) 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 &, Options)

Gets the access control policy for a resource.

May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/snapshots/getIamPolicy

Parameters
Name	Description
project	std::string const & Project ID 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::snapshots::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/snapshots/getIamPolicy

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

InsertSnapshot(std::string const &, google::cloud::cpp::compute::v1::Snapshot const &, Options)

Creates a snapshot in the specified project using the data included in the request.

For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project. https://cloud.google.com/compute/docs/reference/rest/v1/snapshots/insert

Parameters
Name	Description
project	std::string const & Project ID for this request.
snapshot_resource	google::cloud::cpp::compute::v1::Snapshot const & The Snapshot 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.

InsertSnapshot(google::cloud::cpp::compute::snapshots::v1::InsertSnapshotRequest const &, Options)

Creates a snapshot in the specified project using the data included in the request.

For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project. https://cloud.google.com/compute/docs/reference/rest/v1/snapshots/insert

Parameters
Name	Description
request	google::cloud::cpp::compute::snapshots::v1::InsertSnapshotRequest 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.snapshots.v1.InsertSnapshotRequest. 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.

ListSnapshots(std::string const &, Options)

Retrieves the list of Snapshot resources contained within the specified project.

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

Parameters
Name	Description
project	std::string const & Project ID 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::Snapshot >	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.Snapshot, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSnapshots(google::cloud::cpp::compute::snapshots::v1::ListSnapshotsRequest, Options)

Retrieves the list of Snapshot resources contained within the specified project.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::snapshots::v1::ListSnapshotsRequest 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.snapshots.v1.ListSnapshotsRequest. 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::Snapshot >	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.Snapshot, 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 &, google::cloud::cpp::compute::v1::GlobalSetPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/snapshots/setIamPolicy

Parameters
Name	Description
project	std::string const & Project ID for this request.
resource	std::string const & Name or id of the resource for this request.
global_set_policy_request_resource	google::cloud::cpp::compute::v1::GlobalSetPolicyRequest const & The GlobalSetPolicyRequest 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::snapshots::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/snapshots/setIamPolicy

Parameters
Name	Description
request	google::cloud::cpp::compute::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.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 &, google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &, Options)

Sets the labels on a snapshot.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
resource	std::string const & Name or id of the resource for this request.
global_set_labels_request_resource	google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const & The GlobalSetLabelsRequest 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(google::cloud::cpp::compute::snapshots::v1::SetLabelsRequest const &, Options)

Sets the labels on a snapshot.

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

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

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

Returns permissions that a caller has on the specified resource.

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

Parameters
Name	Description
project	std::string const & Project ID 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::snapshots::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

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

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