Class HostsClient (3.9.0-rc)

3.9.0-rc 3.8.0 (latest) 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 2.48.0-rc 2.47.1 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 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.1 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.1

Service for the hosts resource.

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

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

HostsClient(HostsClient const &)

Copy and move support

Parameter
Name	Description
	HostsClient const &

HostsClient(HostsClient &&)

Copy and move support

Parameter
Name	Description
	HostsClient &&

HostsClient(std::shared_ptr< HostsConnection >, Options)

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

Operators

operator=(HostsClient const &)

Copy and move support

Parameter
Name	Description
	HostsClient const &

Returns
Type	Description
HostsClient &

operator=(HostsClient &&)

Copy and move support

Parameter
Name	Description
	HostsClient &&

Returns
Type	Description
HostsClient &

Functions

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

Retrieves information about the specified host.

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

Parameters
Name	Description
project	std::string const & The project ID for this request.
zone	std::string const & The name of the zone for this request, formatted as RFC1035.
association	std::string const & The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host. For example, reservations/reservation_name, reservations/reservation_name/reservationBlocks/reservation_block_name or reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.
host	std::string const & The name of the host, formatted as RFC1035 or a resource ID number.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetHost(google::cloud::cpp::compute::hosts::v1::GetHostRequest const &, Options)

Retrieves information about the specified host.

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

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

GetVersion(std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HostsGetVersionRequest const &, Options)

Allows customers to get SBOM versions of a host.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
zone	std::string const & Name of the zone for this request. Zone name should conform to RFC1035.
association	std::string const & The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host.
host	std::string const & The name of the host, formatted as RFC1035 or a resource ID number.
hosts_get_version_request_resource	google::cloud::cpp::compute::v1::HostsGetVersionRequest const & The HostsGetVersionRequest 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.

GetVersion(NoAwaitTag, std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HostsGetVersionRequest const &, Options)

Allows customers to get SBOM versions of a host.

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 &
zone	std::string const &
association	std::string const &
host	std::string const &
hosts_get_version_request_resource	google::cloud::cpp::compute::v1::HostsGetVersionRequest const &
opts	Options

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

GetVersion(google::cloud::cpp::compute::hosts::v1::GetVersionRequest const &, Options)

Allows customers to get SBOM versions of a host.

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

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

GetVersion(NoAwaitTag, google::cloud::cpp::compute::hosts::v1::GetVersionRequest const &, Options)

Allows customers to get SBOM versions of a host.

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::hosts::v1::GetVersionRequest const &
opts	Options

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

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

Allows customers to get SBOM versions of a host.

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

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

Retrieves a list of hosts.

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

Parameters
Name	Description
project	std::string const & The project ID for this request.
zone	std::string const & The name of the zone for this request, formatted as RFC1035.
association	std::string const & The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host. For example, reservations/reservation_name, reservations/reservation_name/reservationBlocks/reservation_block_name or reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::cpp::compute::v1::Host >	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.Host, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListHosts(google::cloud::cpp::compute::hosts::v1::ListHostsRequest, Options)

Retrieves a list of hosts.

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

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