Class ImagesClient (2.21.0)

Service for the images resource.

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

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

ImagesClient(ImagesClient const &)

Copy and move support

Parameter
Name	Description
	`ImagesClient const &`

ImagesClient(ImagesClient &&)

Copy and move support

Parameter
Name	Description
	`ImagesClient &&`

ImagesClient(std::shared_ptr< ImagesConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ImagesConnection >`
`opts`	`Options`

Operators

operator=(ImagesClient const &)

Copy and move support

Parameter
Name	Description
	`ImagesClient const &`

Returns
Type	Description
`ImagesClient &`

operator=(ImagesClient &&)

Copy and move support

Parameter
Name	Description
	`ImagesClient &&`

Returns
Type	Description
`ImagesClient &`

Functions

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

Deletes the specified image.

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

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

DeleteImage(google::cloud::cpp::compute::images::v1::DeleteImageRequest const &, Options)

Deletes the specified image.

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

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

Deprecate(std::string const &, std::string const &, google::cloud::cpp::compute::v1::DeprecationStatus const &, Options)

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead. https://cloud.google.com/compute/docs/reference/rest/v1/images/deprecate

Parameters
Name	Description
`project`	`std::string const &` Project ID for this request.
`image`	`std::string const &` Image name.
`deprecation_status_resource`	`google::cloud::cpp::compute::v1::DeprecationStatus const &` The DeprecationStatus 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 > >

Deprecate(google::cloud::cpp::compute::images::v1::DeprecateRequest const &, Options)

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead. https://cloud.google.com/compute/docs/reference/rest/v1/images/deprecate

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

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

Returns the specified image.

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

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

GetImage(google::cloud::cpp::compute::images::v1::GetImageRequest const &, Options)

Returns the specified image.

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

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

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

Returns the latest image that is part of an image family and is not deprecated.

For more information on image families, see Public image families documentation. https://cloud.google.com/compute/docs/reference/rest/v1/images/getFromFamily

Parameters
Name	Description
`project`	`std::string const &` The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project.
`family`	`std::string const &` Name of the image family to search for.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::cpp::compute::v1::Image >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Image) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetFromFamily(google::cloud::cpp::compute::images::v1::GetFromFamilyRequest const &, Options)

Returns the latest image that is part of an image family and is not deprecated.

For more information on image families, see Public image families documentation. https://cloud.google.com/compute/docs/reference/rest/v1/images/getFromFamily

Parameters
Name	Description
`request`	`google::cloud::cpp::compute::images::v1::GetFromFamilyRequest 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.images.v1.GetFromFamilyRequest. 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::Image >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Image) 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/images/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::images::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/images/getIamPolicy

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

InsertImage(std::string const &, google::cloud::cpp::compute::v1::Image const &, Options)

Creates an image in the specified project using the data included in the request.

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

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

InsertImage(google::cloud::cpp::compute::images::v1::InsertImageRequest const &, Options)

Creates an image in the specified project using the data included in the request.

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

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

ListImages(std::string const &, Options)

Retrieves the list of custom images available to the specified project.

Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. https://cloud.google.com/compute/docs/reference/rest/v1/images/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::Image >

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

ListImages(google::cloud::cpp::compute::images::v1::ListImagesRequest, Options)

Retrieves the list of custom images available to the specified project.

Parameters
Name	Description
`request`	`google::cloud::cpp::compute::images::v1::ListImagesRequest` 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.images.v1.ListImagesRequest. 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::Image >

PatchImage(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Image const &, Options)

Patches the specified image with the data included in the request.

Only the following fields can be modified: family, description, deprecation status. https://cloud.google.com/compute/docs/reference/rest/v1/images/patch

Parameters
Name	Description
`project`	`std::string const &` Project ID for this request.
`image`	`std::string const &` Name of the image resource to patch.
`image_resource`	`google::cloud::cpp::compute::v1::Image const &` The Image 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 > >

PatchImage(google::cloud::cpp::compute::images::v1::PatchImageRequest const &, Options)

Patches the specified image with the data included in the request.

Only the following fields can be modified: family, description, deprecation status. https://cloud.google.com/compute/docs/reference/rest/v1/images/patch

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

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/images/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::images::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/images/setIamPolicy

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

To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/images/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 > >

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

Sets the labels on an image.

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

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

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/images/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::images::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

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

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