Class AddressesClient (2.20.0)

Version 2.20.0

• 2.33.0-rc (latest)
• 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.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 addresses resource.

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

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

AddressesClient(AddressesClient const &)

Copy and move support

Parameter
Name	Description
	AddressesClient const &

AddressesClient(AddressesClient &&)

Copy and move support

Parameter
Name	Description
	AddressesClient &&

AddressesClient(std::shared_ptr< AddressesConnection >, Options)

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

Operators

operator=(AddressesClient const &)

Copy and move support

Parameter
Name	Description
	AddressesClient const &

Returns
Type	Description
AddressesClient &

operator=(AddressesClient &&)

Copy and move support

Parameter
Name	Description
	AddressesClient &&

Returns
Type	Description
AddressesClient &

Functions

AggregatedListAddresses(std::string const &, Options)

Retrieves an aggregated list of addresses.

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

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

AggregatedListAddresses(google::cloud::cpp::compute::addresses::v1::AggregatedListAddressesRequest, Options)

Retrieves an aggregated list of addresses.

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

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

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

Deletes the specified address resource.

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

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

DeleteAddress(google::cloud::cpp::compute::addresses::v1::DeleteAddressRequest const &, Options)

Deletes the specified address resource.

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

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

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

Returns the specified address resource.

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

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

GetAddress(google::cloud::cpp::compute::addresses::v1::GetAddressRequest const &, Options)

Returns the specified address resource.

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

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

InsertAddress(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Address const &, Options)

Creates an address resource in the specified project by using the data included in the request.

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

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

InsertAddress(google::cloud::cpp::compute::addresses::v1::InsertAddressRequest const &, Options)

Creates an address resource in the specified project by using the data included in the request.

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

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

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

Retrieves a list of addresses contained within the specified region.

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

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

ListAddresses(google::cloud::cpp::compute::addresses::v1::ListAddressesRequest, Options)

Retrieves a list of addresses contained within the specified region.

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

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

Move(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionAddressesMoveRequest const &, Options)

Moves the specified address resource.

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

Parameters
Name	Description
project	std::string const & Source project ID which the Address is moved from.
region	std::string const & Name of the region for this request.
address	std::string const & Name of the address resource to move.
region_addresses_move_request_resource	google::cloud::cpp::compute::v1::RegionAddressesMoveRequest const & The RegionAddressesMoveRequest 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.

Move(google::cloud::cpp::compute::addresses::v1::MoveRequest const &, Options)

Moves the specified address resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::addresses::v1::MoveRequest 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.addresses.v1.MoveRequest. 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(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)

Sets the labels on an Address.

To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/addresses/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(google::cloud::cpp::compute::addresses::v1::SetLabelsRequest const &, Options)

Sets the labels on an Address.

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

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