Service for the publicAdvertisedPrefixes resource.
https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes
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
PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicAdvertisedPrefixesClient const &
|
PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicAdvertisedPrefixesClient &&
|
PublicAdvertisedPrefixesClient(std::shared_ptr< PublicAdvertisedPrefixesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< PublicAdvertisedPrefixesConnection >
|
opts |
Options
|
Operators
operator=(PublicAdvertisedPrefixesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicAdvertisedPrefixesClient const &
|
Returns | |
---|---|
Type | Description |
PublicAdvertisedPrefixesClient & |
operator=(PublicAdvertisedPrefixesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicAdvertisedPrefixesClient &&
|
Returns | |
---|---|
Type | Description |
PublicAdvertisedPrefixesClient & |
Functions
Announce(std::string const &, std::string const &, Options)
Announces the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/announce.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
public_advertised_prefix |
std::string const &
The name of the public advertised prefix. It should comply with RFC1035. |
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 |
Announce(NoAwaitTag, std::string const &, std::string const &, Options)
Announces the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/announce.
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 &
|
public_advertised_prefix |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Announce(google::cloud::cpp::compute::public_advertised_prefixes::v1::AnnounceRequest const &, Options)
Announces the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/announce.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_advertised_prefixes::v1::AnnounceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
Announce(NoAwaitTag, google::cloud::cpp::compute::public_advertised_prefixes::v1::AnnounceRequest const &, Options)
Announces the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/announce.
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::public_advertised_prefixes::v1::AnnounceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Announce(google::cloud::cpp::compute::v1::Operation const &, Options)
Announces the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/announce.
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 > > |
DeletePublicAdvertisedPrefix(std::string const &, std::string const &, Options)
Deletes the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/delete.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
public_advertised_prefix |
std::string const &
Name of the PublicAdvertisedPrefix 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 |
DeletePublicAdvertisedPrefix(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/delete.
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 &
|
public_advertised_prefix |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeletePublicAdvertisedPrefix(google::cloud::cpp::compute::public_advertised_prefixes::v1::DeletePublicAdvertisedPrefixRequest const &, Options)
Deletes the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/delete.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_advertised_prefixes::v1::DeletePublicAdvertisedPrefixRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
DeletePublicAdvertisedPrefix(NoAwaitTag, google::cloud::cpp::compute::public_advertised_prefixes::v1::DeletePublicAdvertisedPrefixRequest const &, Options)
Deletes the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/delete.
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::public_advertised_prefixes::v1::DeletePublicAdvertisedPrefixRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeletePublicAdvertisedPrefix(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/delete.
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 > > |
GetPublicAdvertisedPrefix(std::string const &, std::string const &, Options)
Returns the specified PublicAdvertisedPrefix resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
public_advertised_prefix |
std::string const &
Name of the PublicAdvertisedPrefix 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::PublicAdvertisedPrefix > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.PublicAdvertisedPrefix) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetPublicAdvertisedPrefix(google::cloud::cpp::compute::public_advertised_prefixes::v1::GetPublicAdvertisedPrefixRequest const &, Options)
Returns the specified PublicAdvertisedPrefix resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_advertised_prefixes::v1::GetPublicAdvertisedPrefixRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::PublicAdvertisedPrefix > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.PublicAdvertisedPrefix) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertPublicAdvertisedPrefix(std::string const &, google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &, Options)
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
public_advertised_prefix_resource |
google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &
The PublicAdvertisedPrefix 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 |
InsertPublicAdvertisedPrefix(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &, Options)
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
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 &
|
public_advertised_prefix_resource |
google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertPublicAdvertisedPrefix(google::cloud::cpp::compute::public_advertised_prefixes::v1::InsertPublicAdvertisedPrefixRequest const &, Options)
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_advertised_prefixes::v1::InsertPublicAdvertisedPrefixRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
InsertPublicAdvertisedPrefix(NoAwaitTag, google::cloud::cpp::compute::public_advertised_prefixes::v1::InsertPublicAdvertisedPrefixRequest const &, Options)
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
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::public_advertised_prefixes::v1::InsertPublicAdvertisedPrefixRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertPublicAdvertisedPrefix(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
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 > > |
ListPublicAdvertisedPrefixes(std::string const &, Options)
Lists the PublicAdvertisedPrefixes for a project.
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::PublicAdvertisedPrefix > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListPublicAdvertisedPrefixes(google::cloud::cpp::compute::public_advertised_prefixes::v1::ListPublicAdvertisedPrefixesRequest, Options)
Lists the PublicAdvertisedPrefixes for a project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_advertised_prefixes::v1::ListPublicAdvertisedPrefixesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::PublicAdvertisedPrefix > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchPublicAdvertisedPrefix(std::string const &, std::string const &, google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &, Options)
Patches the specified Router resource with the data included in the request.
This method supports PATCH semantics and uses JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
public_advertised_prefix |
std::string const &
Name of the PublicAdvertisedPrefix resource to patch. |
public_advertised_prefix_resource |
google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &
The PublicAdvertisedPrefix 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 |
PatchPublicAdvertisedPrefix(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &, Options)
Patches the specified Router resource with the data included in the request.
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 &
|
public_advertised_prefix |
std::string const &
|
public_advertised_prefix_resource |
google::cloud::cpp::compute::v1::PublicAdvertisedPrefix const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchPublicAdvertisedPrefix(google::cloud::cpp::compute::public_advertised_prefixes::v1::PatchPublicAdvertisedPrefixRequest const &, Options)
Patches the specified Router resource with the data included in the request.
This method supports PATCH semantics and uses JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_advertised_prefixes::v1::PatchPublicAdvertisedPrefixRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
PatchPublicAdvertisedPrefix(NoAwaitTag, google::cloud::cpp::compute::public_advertised_prefixes::v1::PatchPublicAdvertisedPrefixRequest const &, Options)
Patches the specified Router resource with the data included in the request.
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::public_advertised_prefixes::v1::PatchPublicAdvertisedPrefixRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchPublicAdvertisedPrefix(google::cloud::cpp::compute::v1::Operation const &, Options)
Patches the specified Router resource with the data included in the request.
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 > > |
Withdraw(std::string const &, std::string const &, Options)
Withdraws the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/withdraw.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
public_advertised_prefix |
std::string const &
The name of the public advertised prefix. It should comply with RFC1035. |
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 |
Withdraw(NoAwaitTag, std::string const &, std::string const &, Options)
Withdraws the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/withdraw.
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 &
|
public_advertised_prefix |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Withdraw(google::cloud::cpp::compute::public_advertised_prefixes::v1::WithdrawRequest const &, Options)
Withdraws the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/withdraw.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_advertised_prefixes::v1::WithdrawRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
Withdraw(NoAwaitTag, google::cloud::cpp::compute::public_advertised_prefixes::v1::WithdrawRequest const &, Options)
Withdraws the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/withdraw.
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::public_advertised_prefixes::v1::WithdrawRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Withdraw(google::cloud::cpp::compute::v1::Operation const &, Options)
Withdraws the specified PublicAdvertisedPrefix https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes/withdraw.
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 > > |