Service for the forwardingRules resource.
https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules
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
ForwardingRulesClient(ForwardingRulesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ForwardingRulesClient const &
|
ForwardingRulesClient(ForwardingRulesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ForwardingRulesClient &&
|
ForwardingRulesClient(std::shared_ptr< ForwardingRulesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ForwardingRulesConnection >
|
opts |
Options
|
Operators
operator=(ForwardingRulesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ForwardingRulesClient const &
|
Returns | |
---|---|
Type | Description |
ForwardingRulesClient & |
operator=(ForwardingRulesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ForwardingRulesClient &&
|
Returns | |
---|---|
Type | Description |
ForwardingRulesClient & |
Functions
AggregatedListForwardingRules(std::string const &, Options)
Retrieves an aggregated list of forwarding rules.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/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::ForwardingRulesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListForwardingRules(google::cloud::cpp::compute::forwarding_rules::v1::AggregatedListForwardingRulesRequest, Options)
Retrieves an aggregated list of forwarding rules.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::AggregatedListForwardingRulesRequest
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::ForwardingRulesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteForwardingRule(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified ForwardingRule resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping this request. |
forwarding_rule |
std::string const &
Name of the ForwardingRule 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 |
DeleteForwardingRule(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified ForwardingRule resource.
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 &
|
forwarding_rule |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteForwardingRule(google::cloud::cpp::compute::forwarding_rules::v1::DeleteForwardingRuleRequest const &, Options)
Deletes the specified ForwardingRule resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::DeleteForwardingRuleRequest 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 |
DeleteForwardingRule(NoAwaitTag, google::cloud::cpp::compute::forwarding_rules::v1::DeleteForwardingRuleRequest const &, Options)
Deletes the specified ForwardingRule resource.
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::forwarding_rules::v1::DeleteForwardingRuleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteForwardingRule(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified ForwardingRule resource.
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 > > |
GetForwardingRule(std::string const &, std::string const &, std::string const &, Options)
Returns the specified ForwardingRule resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping this request. |
forwarding_rule |
std::string const &
Name of the ForwardingRule 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::ForwardingRule > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ForwardingRule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetForwardingRule(google::cloud::cpp::compute::forwarding_rules::v1::GetForwardingRuleRequest const &, Options)
Returns the specified ForwardingRule resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::GetForwardingRuleRequest 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::ForwardingRule > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ForwardingRule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertForwardingRule(std::string const &, std::string const &, google::cloud::cpp::compute::v1::ForwardingRule const &, Options)
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping this request. |
forwarding_rule_resource |
google::cloud::cpp::compute::v1::ForwardingRule const &
The ForwardingRule 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 |
InsertForwardingRule(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ForwardingRule const &, Options)
Creates a ForwardingRule resource in the specified project and region using 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 &
|
forwarding_rule_resource |
google::cloud::cpp::compute::v1::ForwardingRule const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertForwardingRule(google::cloud::cpp::compute::forwarding_rules::v1::InsertForwardingRuleRequest const &, Options)
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::InsertForwardingRuleRequest 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 |
InsertForwardingRule(NoAwaitTag, google::cloud::cpp::compute::forwarding_rules::v1::InsertForwardingRuleRequest const &, Options)
Creates a ForwardingRule resource in the specified project and region using 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::forwarding_rules::v1::InsertForwardingRuleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertForwardingRule(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a ForwardingRule resource in the specified project and region using 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 > > |
ListForwardingRules(std::string const &, std::string const &, Options)
Retrieves a list of ForwardingRule resources available to the specified project and region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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::ForwardingRule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListForwardingRules(google::cloud::cpp::compute::forwarding_rules::v1::ListForwardingRulesRequest, Options)
Retrieves a list of ForwardingRule resources available to the specified project and region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::ListForwardingRulesRequest
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::ForwardingRule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchForwardingRule(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ForwardingRule const &, Options)
Updates the specified forwarding rule with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping this request. |
forwarding_rule |
std::string const &
Name of the ForwardingRule resource to patch. |
forwarding_rule_resource |
google::cloud::cpp::compute::v1::ForwardingRule const &
The ForwardingRule 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 |
PatchForwardingRule(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ForwardingRule const &, Options)
Updates the specified forwarding rule 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 &
|
forwarding_rule |
std::string const &
|
forwarding_rule_resource |
google::cloud::cpp::compute::v1::ForwardingRule const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchForwardingRule(google::cloud::cpp::compute::forwarding_rules::v1::PatchForwardingRuleRequest const &, Options)
Updates the specified forwarding rule with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::PatchForwardingRuleRequest 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 |
PatchForwardingRule(NoAwaitTag, google::cloud::cpp::compute::forwarding_rules::v1::PatchForwardingRuleRequest const &, Options)
Updates the specified forwarding rule 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::forwarding_rules::v1::PatchForwardingRuleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchForwardingRule(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified forwarding rule 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 > > |
SetLabels(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)
Sets the labels on the specified resource.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/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 |
SetLabels(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)
Sets the labels on the specified resource.
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 &
|
resource |
std::string const &
|
region_set_labels_request_resource |
google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(google::cloud::cpp::compute::forwarding_rules::v1::SetLabelsRequest const &, Options)
Sets the labels on the specified resource.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/setLabels
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::SetLabelsRequest 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 |
SetLabels(NoAwaitTag, google::cloud::cpp::compute::forwarding_rules::v1::SetLabelsRequest const &, Options)
Sets the labels on the specified resource.
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::forwarding_rules::v1::SetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(google::cloud::cpp::compute::v1::Operation const &, Options)
Sets the labels on the specified resource.
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 > > |
SetTarget(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetReference const &, Options)
Changes target URL for forwarding rule.
The new target should be of the same type as the old target. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/setTarget
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping this request. |
forwarding_rule |
std::string const &
Name of the ForwardingRule resource in which target is to be set. |
target_reference_resource |
google::cloud::cpp::compute::v1::TargetReference const &
The TargetReference 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 |
SetTarget(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetReference const &, Options)
Changes target URL for forwarding rule.
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 &
|
forwarding_rule |
std::string const &
|
target_reference_resource |
google::cloud::cpp::compute::v1::TargetReference const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetTarget(google::cloud::cpp::compute::forwarding_rules::v1::SetTargetRequest const &, Options)
Changes target URL for forwarding rule.
The new target should be of the same type as the old target. https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules/setTarget
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::forwarding_rules::v1::SetTargetRequest 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 |
SetTarget(NoAwaitTag, google::cloud::cpp::compute::forwarding_rules::v1::SetTargetRequest const &, Options)
Changes target URL for forwarding rule.
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::forwarding_rules::v1::SetTargetRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetTarget(google::cloud::cpp::compute::v1::Operation const &, Options)
Changes target URL for forwarding rule.
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 > > |