Service for the firewalls resource.
https://cloud.google.com/compute/docs/reference/rest/v1/firewalls
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
FirewallsClient(FirewallsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FirewallsClient const &
|
FirewallsClient(FirewallsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FirewallsClient &&
|
FirewallsClient(std::shared_ptr< FirewallsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< FirewallsConnection >
|
opts |
Options
|
Operators
operator=(FirewallsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FirewallsClient const &
|
Returns | |
---|---|
Type | Description |
FirewallsClient & |
operator=(FirewallsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FirewallsClient &&
|
Returns | |
---|---|
Type | Description |
FirewallsClient & |
Functions
DeleteFirewall(std::string const &, std::string const &, Options)
Deletes the specified firewall.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
firewall |
std::string const &
Name of the firewall rule 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 |
DeleteFirewall(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified firewall.
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 &
|
firewall |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteFirewall(google::cloud::cpp::compute::firewalls::v1::DeleteFirewallRequest const &, Options)
Deletes the specified firewall.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::firewalls::v1::DeleteFirewallRequest 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 |
DeleteFirewall(NoAwaitTag, google::cloud::cpp::compute::firewalls::v1::DeleteFirewallRequest const &, Options)
Deletes the specified firewall.
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::firewalls::v1::DeleteFirewallRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteFirewall(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified firewall.
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 > > |
GetFirewall(std::string const &, std::string const &, Options)
Returns the specified firewall.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
firewall |
std::string const &
Name of the firewall rule 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::Firewall > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Firewall) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetFirewall(google::cloud::cpp::compute::firewalls::v1::GetFirewallRequest const &, Options)
Returns the specified firewall.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::firewalls::v1::GetFirewallRequest 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::Firewall > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Firewall) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertFirewall(std::string const &, google::cloud::cpp::compute::v1::Firewall const &, Options)
Creates a firewall rule in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
firewall_resource |
google::cloud::cpp::compute::v1::Firewall const &
The Firewall 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 |
InsertFirewall(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::Firewall const &, Options)
Creates a firewall rule in the specified project 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 &
|
firewall_resource |
google::cloud::cpp::compute::v1::Firewall const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertFirewall(google::cloud::cpp::compute::firewalls::v1::InsertFirewallRequest const &, Options)
Creates a firewall rule in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::firewalls::v1::InsertFirewallRequest 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 |
InsertFirewall(NoAwaitTag, google::cloud::cpp::compute::firewalls::v1::InsertFirewallRequest const &, Options)
Creates a firewall rule in the specified project 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::firewalls::v1::InsertFirewallRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertFirewall(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a firewall rule in the specified project 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 > > |
ListFirewalls(std::string const &, Options)
Retrieves the list of firewall rules available to the specified 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::Firewall > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListFirewalls(google::cloud::cpp::compute::firewalls::v1::ListFirewallsRequest, Options)
Retrieves the list of firewall rules available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::firewalls::v1::ListFirewallsRequest
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::Firewall > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchFirewall(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Firewall const &, Options)
Updates the specified firewall rule with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/firewalls/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
firewall |
std::string const &
Name of the firewall rule to patch. |
firewall_resource |
google::cloud::cpp::compute::v1::Firewall const &
The Firewall 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 |
PatchFirewall(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Firewall const &, Options)
Updates the specified firewall 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 &
|
firewall |
std::string const &
|
firewall_resource |
google::cloud::cpp::compute::v1::Firewall const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchFirewall(google::cloud::cpp::compute::firewalls::v1::PatchFirewallRequest const &, Options)
Updates the specified firewall rule with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/firewalls/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::firewalls::v1::PatchFirewallRequest 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 |
PatchFirewall(NoAwaitTag, google::cloud::cpp::compute::firewalls::v1::PatchFirewallRequest const &, Options)
Updates the specified firewall 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::firewalls::v1::PatchFirewallRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchFirewall(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified firewall 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 > > |
UpdateFirewall(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Firewall const &, Options)
Updates the specified firewall rule with the data included in the request.
Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. https://cloud.google.com/compute/docs/reference/rest/v1/firewalls/update
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
firewall |
std::string const &
Name of the firewall rule to update. |
firewall_resource |
google::cloud::cpp::compute::v1::Firewall const &
The Firewall 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 |
UpdateFirewall(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Firewall const &, Options)
Updates the specified firewall 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 &
|
firewall |
std::string const &
|
firewall_resource |
google::cloud::cpp::compute::v1::Firewall const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateFirewall(google::cloud::cpp::compute::firewalls::v1::UpdateFirewallRequest const &, Options)
Updates the specified firewall rule with the data included in the request.
Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. https://cloud.google.com/compute/docs/reference/rest/v1/firewalls/update
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::firewalls::v1::UpdateFirewallRequest 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 |
UpdateFirewall(NoAwaitTag, google::cloud::cpp::compute::firewalls::v1::UpdateFirewallRequest const &, Options)
Updates the specified firewall 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::firewalls::v1::UpdateFirewallRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateFirewall(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified firewall 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 > > |