Service for the publicDelegatedPrefixes resource.
https://cloud.google.com/compute/docs/reference/rest/v1/publicDelegatedPrefixes
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
PublicDelegatedPrefixesClient(PublicDelegatedPrefixesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicDelegatedPrefixesClient const &
|
PublicDelegatedPrefixesClient(PublicDelegatedPrefixesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicDelegatedPrefixesClient &&
|
PublicDelegatedPrefixesClient(std::shared_ptr< PublicDelegatedPrefixesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< PublicDelegatedPrefixesConnection >
|
opts |
Options
|
Operators
operator=(PublicDelegatedPrefixesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicDelegatedPrefixesClient const &
|
Returns | |
---|---|
Type | Description |
PublicDelegatedPrefixesClient & |
operator=(PublicDelegatedPrefixesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PublicDelegatedPrefixesClient &&
|
Returns | |
---|---|
Type | Description |
PublicDelegatedPrefixesClient & |
Functions
AggregatedListPublicDelegatedPrefixes(std::string const &, Options)
Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/publicDelegatedPrefixes/aggregatedList
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Name of the project scoping 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::PublicDelegatedPrefixesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListPublicDelegatedPrefixes(google::cloud::cpp::compute::public_delegated_prefixes::v1::AggregatedListPublicDelegatedPrefixesRequest, Options)
Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/publicDelegatedPrefixes/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_prefixes::v1::AggregatedListPublicDelegatedPrefixesRequest
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< std::pair< std::string, google::cloud::cpp::compute::v1::PublicDelegatedPrefixesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
Announce(std::string const &, std::string const &, std::string const &, Options)
Announces the specified PublicDelegatedPrefix in the given region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where the public delegated prefix is located. It should comply with RFC1035. |
public_delegated_prefix |
std::string const &
The name of the public delegated 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 &, std::string const &, Options)
Announces the specified PublicDelegatedPrefix in the given region.
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 &
|
region |
std::string const &
|
public_delegated_prefix |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Announce(google::cloud::cpp::compute::public_delegated_prefixes::v1::AnnounceRequest const &, Options)
Announces the specified PublicDelegatedPrefix in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_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_delegated_prefixes::v1::AnnounceRequest const &, Options)
Announces the specified PublicDelegatedPrefix in the given region.
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_delegated_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 PublicDelegatedPrefix in the given region.
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 > > |
DeletePublicDelegatedPrefix(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified PublicDelegatedPrefix in the given region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of this request. |
public_delegated_prefix |
std::string const &
Name of the PublicDelegatedPrefix 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 |
DeletePublicDelegatedPrefix(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified PublicDelegatedPrefix in the given region.
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 &
|
region |
std::string const &
|
public_delegated_prefix |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeletePublicDelegatedPrefix(google::cloud::cpp::compute::public_delegated_prefixes::v1::DeletePublicDelegatedPrefixRequest const &, Options)
Deletes the specified PublicDelegatedPrefix in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_prefixes::v1::DeletePublicDelegatedPrefixRequest 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 |
DeletePublicDelegatedPrefix(NoAwaitTag, google::cloud::cpp::compute::public_delegated_prefixes::v1::DeletePublicDelegatedPrefixRequest const &, Options)
Deletes the specified PublicDelegatedPrefix in the given region.
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_delegated_prefixes::v1::DeletePublicDelegatedPrefixRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeletePublicDelegatedPrefix(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified PublicDelegatedPrefix in the given region.
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 > > |
GetPublicDelegatedPrefix(std::string const &, std::string const &, std::string const &, Options)
Returns the specified PublicDelegatedPrefix resource in the given region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of this request. |
public_delegated_prefix |
std::string const &
Name of the PublicDelegatedPrefix 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::PublicDelegatedPrefix > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.PublicDelegatedPrefix) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetPublicDelegatedPrefix(google::cloud::cpp::compute::public_delegated_prefixes::v1::GetPublicDelegatedPrefixRequest const &, Options)
Returns the specified PublicDelegatedPrefix resource in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_prefixes::v1::GetPublicDelegatedPrefixRequest 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::PublicDelegatedPrefix > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.PublicDelegatedPrefix) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertPublicDelegatedPrefix(std::string const &, std::string const &, google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &, Options)
Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of this request. |
public_delegated_prefix_resource |
google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &
The PublicDelegatedPrefix 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 |
InsertPublicDelegatedPrefix(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &, Options)
Creates a PublicDelegatedPrefix in the specified project in the given region 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 &
|
region |
std::string const &
|
public_delegated_prefix_resource |
google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertPublicDelegatedPrefix(google::cloud::cpp::compute::public_delegated_prefixes::v1::InsertPublicDelegatedPrefixRequest const &, Options)
Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_prefixes::v1::InsertPublicDelegatedPrefixRequest 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 |
InsertPublicDelegatedPrefix(NoAwaitTag, google::cloud::cpp::compute::public_delegated_prefixes::v1::InsertPublicDelegatedPrefixRequest const &, Options)
Creates a PublicDelegatedPrefix in the specified project in the given region 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_delegated_prefixes::v1::InsertPublicDelegatedPrefixRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertPublicDelegatedPrefix(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a PublicDelegatedPrefix in the specified project in the given region 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 > > |
ListPublicDelegatedPrefixes(std::string const &, std::string const &, Options)
Lists the PublicDelegatedPrefixes for a project in the given region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of 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::PublicDelegatedPrefix > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListPublicDelegatedPrefixes(google::cloud::cpp::compute::public_delegated_prefixes::v1::ListPublicDelegatedPrefixesRequest, Options)
Lists the PublicDelegatedPrefixes for a project in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_prefixes::v1::ListPublicDelegatedPrefixesRequest
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::PublicDelegatedPrefix > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchPublicDelegatedPrefix(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &, Options)
Patches the specified PublicDelegatedPrefix 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/publicDelegatedPrefixes/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
public_delegated_prefix |
std::string const &
Name of the PublicDelegatedPrefix resource to patch. |
public_delegated_prefix_resource |
google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &
The PublicDelegatedPrefix 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 |
PatchPublicDelegatedPrefix(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &, Options)
Patches the specified PublicDelegatedPrefix 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 &
|
region |
std::string const &
|
public_delegated_prefix |
std::string const &
|
public_delegated_prefix_resource |
google::cloud::cpp::compute::v1::PublicDelegatedPrefix const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchPublicDelegatedPrefix(google::cloud::cpp::compute::public_delegated_prefixes::v1::PatchPublicDelegatedPrefixRequest const &, Options)
Patches the specified PublicDelegatedPrefix 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/publicDelegatedPrefixes/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_prefixes::v1::PatchPublicDelegatedPrefixRequest 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 |
PatchPublicDelegatedPrefix(NoAwaitTag, google::cloud::cpp::compute::public_delegated_prefixes::v1::PatchPublicDelegatedPrefixRequest const &, Options)
Patches the specified PublicDelegatedPrefix 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_delegated_prefixes::v1::PatchPublicDelegatedPrefixRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchPublicDelegatedPrefix(google::cloud::cpp::compute::v1::Operation const &, Options)
Patches the specified PublicDelegatedPrefix 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 &, std::string const &, Options)
Withdraws the specified PublicDelegatedPrefix in the given region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where the public delegated prefix is located. It should comply with RFC1035. |
public_delegated_prefix |
std::string const &
The name of the public delegated 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 &, std::string const &, Options)
Withdraws the specified PublicDelegatedPrefix in the given region.
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 &
|
region |
std::string const &
|
public_delegated_prefix |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Withdraw(google::cloud::cpp::compute::public_delegated_prefixes::v1::WithdrawRequest const &, Options)
Withdraws the specified PublicDelegatedPrefix in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::public_delegated_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_delegated_prefixes::v1::WithdrawRequest const &, Options)
Withdraws the specified PublicDelegatedPrefix in the given region.
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_delegated_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 PublicDelegatedPrefix in the given region.
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 > > |