Class EdgeNetworkClient (2.27.0-rc)

EdgeNetwork API provides managed, highly available cloud dynamic network configuration service to the GEC customer to enable edge application and network function solutions.

This allows the customers to easily define and configure the network setup and property to meet the workload requirement.

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

EdgeNetworkClient(EdgeNetworkClient const &)

Copy and move support

Parameter
Name Description
EdgeNetworkClient const &

EdgeNetworkClient(EdgeNetworkClient &&)

Copy and move support

Parameter
Name Description
EdgeNetworkClient &&

EdgeNetworkClient(std::shared_ptr< EdgeNetworkConnection >, Options)

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

Operators

operator=(EdgeNetworkClient const &)

Copy and move support

Parameter
Name Description
EdgeNetworkClient const &
Returns
Type Description
EdgeNetworkClient &

operator=(EdgeNetworkClient &&)

Copy and move support

Parameter
Name Description
EdgeNetworkClient &&
Returns
Type Description
EdgeNetworkClient &

Functions

InitializeZone(std::string const &, Options)

InitializeZone will initialize resources for a zone in a project.

Parameters
Name Description
name std::string const &

Required. The name of the zone resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::InitializeZoneResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.InitializeZoneResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InitializeZone(google::cloud::edgenetwork::v1::InitializeZoneRequest const &, Options)

InitializeZone will initialize resources for a zone in a project.

Parameters
Name Description
request google::cloud::edgenetwork::v1::InitializeZoneRequest 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.edgenetwork.v1.InitializeZoneRequest. 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::edgenetwork::v1::InitializeZoneResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.InitializeZoneResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListZones(std::string const &, Options)

Deprecated: not implemented.

Lists Zones in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListZonesRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::edgenetwork::v1::Zone >

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.edgenetwork.v1.Zone, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListZones(google::cloud::edgenetwork::v1::ListZonesRequest, Options)

Deprecated: not implemented.

Lists Zones in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::ListZonesRequest

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.edgenetwork.v1.ListZonesRequest. 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::edgenetwork::v1::Zone >

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.edgenetwork.v1.Zone, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetZone(std::string const &, Options)

Deprecated: not implemented.

Gets details of a single Zone.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::Zone >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Zone) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetZone(google::cloud::edgenetwork::v1::GetZoneRequest const &, Options)

Deprecated: not implemented.

Gets details of a single Zone.

Parameters
Name Description
request google::cloud::edgenetwork::v1::GetZoneRequest 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.edgenetwork.v1.GetZoneRequest. 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::edgenetwork::v1::Zone >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Zone) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListNetworks(std::string const &, Options)

Lists Networks in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListNetworksRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::edgenetwork::v1::Network >

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.edgenetwork.v1.Network, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNetworks(google::cloud::edgenetwork::v1::ListNetworksRequest, Options)

Lists Networks in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::ListNetworksRequest

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.edgenetwork.v1.ListNetworksRequest. 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::edgenetwork::v1::Network >

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.edgenetwork.v1.Network, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetNetwork(std::string const &, Options)

Gets details of a single Network.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::Network >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Network) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNetwork(google::cloud::edgenetwork::v1::GetNetworkRequest const &, Options)

Gets details of a single Network.

Parameters
Name Description
request google::cloud::edgenetwork::v1::GetNetworkRequest 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.edgenetwork.v1.GetNetworkRequest. 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::edgenetwork::v1::Network >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Network) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DiagnoseNetwork(std::string const &, Options)

Get the diagnostics of a single network resource.

Parameters
Name Description
name std::string const &

Required. The name of the network resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::DiagnoseNetworkResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.DiagnoseNetworkResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DiagnoseNetwork(google::cloud::edgenetwork::v1::DiagnoseNetworkRequest const &, Options)

Get the diagnostics of a single network resource.

Parameters
Name Description
request google::cloud::edgenetwork::v1::DiagnoseNetworkRequest 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.edgenetwork.v1.DiagnoseNetworkRequest. 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::edgenetwork::v1::DiagnoseNetworkResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.DiagnoseNetworkResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateNetwork(std::string const &, google::cloud::edgenetwork::v1::Network const &, std::string const &, Options)

Creates a new Network in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

network google::cloud::edgenetwork::v1::Network const &

Required. The resource being created

network_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and network_id from the method_signature of Create RPC

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Network > >

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.edgenetwork.v1.Network proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateNetwork(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::edgenetwork::v1::Network const &, std::string const &, Options)

Creates a new Network in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
parent std::string const &
network google::cloud::edgenetwork::v1::Network const &
network_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateNetwork(google::cloud::edgenetwork::v1::CreateNetworkRequest const &, Options)

Creates a new Network in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::CreateNetworkRequest 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.edgenetwork.v1.CreateNetworkRequest. 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::edgenetwork::v1::Network > >

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.edgenetwork.v1.Network proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateNetwork(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::CreateNetworkRequest const &, Options)

Creates a new Network in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::CreateNetworkRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateNetwork(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a new Network in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Network > >

DeleteNetwork(std::string const &, Options)

Deletes a single Network.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteNetwork(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a single Network.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteNetwork(google::cloud::edgenetwork::v1::DeleteNetworkRequest const &, Options)

Deletes a single Network.

Parameters
Name Description
request google::cloud::edgenetwork::v1::DeleteNetworkRequest 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.edgenetwork.v1.DeleteNetworkRequest. 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::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteNetwork(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::DeleteNetworkRequest const &, Options)

Deletes a single Network.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::DeleteNetworkRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteNetwork(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a single Network.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >

ListSubnets(std::string const &, Options)

Lists Subnets in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListSubnetsRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::edgenetwork::v1::Subnet >

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.edgenetwork.v1.Subnet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSubnets(google::cloud::edgenetwork::v1::ListSubnetsRequest, Options)

Lists Subnets in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::ListSubnetsRequest

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.edgenetwork.v1.ListSubnetsRequest. 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::edgenetwork::v1::Subnet >

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.edgenetwork.v1.Subnet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetSubnet(std::string const &, Options)

Gets details of a single Subnet.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::Subnet >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Subnet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSubnet(google::cloud::edgenetwork::v1::GetSubnetRequest const &, Options)

Gets details of a single Subnet.

Parameters
Name Description
request google::cloud::edgenetwork::v1::GetSubnetRequest 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.edgenetwork.v1.GetSubnetRequest. 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::edgenetwork::v1::Subnet >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Subnet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSubnet(std::string const &, google::cloud::edgenetwork::v1::Subnet const &, std::string const &, Options)

Creates a new Subnet in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

subnet google::cloud::edgenetwork::v1::Subnet const &

Required. The resource being created

subnet_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and subnet_id from the method_signature of Create RPC

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Subnet > >

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.edgenetwork.v1.Subnet proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSubnet(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::edgenetwork::v1::Subnet const &, std::string const &, Options)

Creates a new Subnet in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
parent std::string const &
subnet google::cloud::edgenetwork::v1::Subnet const &
subnet_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateSubnet(google::cloud::edgenetwork::v1::CreateSubnetRequest const &, Options)

Creates a new Subnet in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::CreateSubnetRequest 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.edgenetwork.v1.CreateSubnetRequest. 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::edgenetwork::v1::Subnet > >

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.edgenetwork.v1.Subnet proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSubnet(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::CreateSubnetRequest const &, Options)

Creates a new Subnet in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::CreateSubnetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateSubnet(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a new Subnet in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Subnet > >

UpdateSubnet(google::cloud::edgenetwork::v1::Subnet const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Subnet.

Parameters
Name Description
subnet google::cloud::edgenetwork::v1::Subnet const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Subnet resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Subnet > >

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.edgenetwork.v1.Subnet proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateSubnet(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::Subnet const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Subnet.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
subnet google::cloud::edgenetwork::v1::Subnet const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateSubnet(google::cloud::edgenetwork::v1::UpdateSubnetRequest const &, Options)

Updates the parameters of a single Subnet.

Parameters
Name Description
request google::cloud::edgenetwork::v1::UpdateSubnetRequest 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.edgenetwork.v1.UpdateSubnetRequest. 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::edgenetwork::v1::Subnet > >

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.edgenetwork.v1.Subnet proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateSubnet(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::UpdateSubnetRequest const &, Options)

Updates the parameters of a single Subnet.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::UpdateSubnetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateSubnet(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the parameters of a single Subnet.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Subnet > >

DeleteSubnet(std::string const &, Options)

Deletes a single Subnet.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSubnet(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a single Subnet.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteSubnet(google::cloud::edgenetwork::v1::DeleteSubnetRequest const &, Options)

Deletes a single Subnet.

Parameters
Name Description
request google::cloud::edgenetwork::v1::DeleteSubnetRequest 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.edgenetwork.v1.DeleteSubnetRequest. 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::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSubnet(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::DeleteSubnetRequest const &, Options)

Deletes a single Subnet.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::DeleteSubnetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteSubnet(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a single Subnet.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >

ListInterconnects(std::string const &, Options)

Lists Interconnects in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListInterconnectsRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::edgenetwork::v1::Interconnect >

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.edgenetwork.v1.Interconnect, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInterconnects(google::cloud::edgenetwork::v1::ListInterconnectsRequest, Options)

Lists Interconnects in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::ListInterconnectsRequest

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.edgenetwork.v1.ListInterconnectsRequest. 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::edgenetwork::v1::Interconnect >

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.edgenetwork.v1.Interconnect, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetInterconnect(std::string const &, Options)

Gets details of a single Interconnect.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::Interconnect >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Interconnect) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInterconnect(google::cloud::edgenetwork::v1::GetInterconnectRequest const &, Options)

Gets details of a single Interconnect.

Parameters
Name Description
request google::cloud::edgenetwork::v1::GetInterconnectRequest 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.edgenetwork.v1.GetInterconnectRequest. 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::edgenetwork::v1::Interconnect >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Interconnect) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DiagnoseInterconnect(std::string const &, Options)

Get the diagnostics of a single interconnect resource.

Parameters
Name Description
name std::string const &

Required. The name of the interconnect resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::DiagnoseInterconnectResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.DiagnoseInterconnectResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DiagnoseInterconnect(google::cloud::edgenetwork::v1::DiagnoseInterconnectRequest const &, Options)

Get the diagnostics of a single interconnect resource.

Parameters
Name Description
request google::cloud::edgenetwork::v1::DiagnoseInterconnectRequest 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.edgenetwork.v1.DiagnoseInterconnectRequest. 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::edgenetwork::v1::DiagnoseInterconnectResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.DiagnoseInterconnectResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListInterconnectAttachments(std::string const &, Options)

Lists InterconnectAttachments in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListInterconnectAttachmentsRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::edgenetwork::v1::InterconnectAttachment >

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.edgenetwork.v1.InterconnectAttachment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInterconnectAttachments(google::cloud::edgenetwork::v1::ListInterconnectAttachmentsRequest, Options)

Lists InterconnectAttachments in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::ListInterconnectAttachmentsRequest

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.edgenetwork.v1.ListInterconnectAttachmentsRequest. 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::edgenetwork::v1::InterconnectAttachment >

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.edgenetwork.v1.InterconnectAttachment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetInterconnectAttachment(std::string const &, Options)

Gets details of a single InterconnectAttachment.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::InterconnectAttachment >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.InterconnectAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInterconnectAttachment(google::cloud::edgenetwork::v1::GetInterconnectAttachmentRequest const &, Options)

Gets details of a single InterconnectAttachment.

Parameters
Name Description
request google::cloud::edgenetwork::v1::GetInterconnectAttachmentRequest 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.edgenetwork.v1.GetInterconnectAttachmentRequest. 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::edgenetwork::v1::InterconnectAttachment >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.InterconnectAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateInterconnectAttachment(std::string const &, google::cloud::edgenetwork::v1::InterconnectAttachment const &, std::string const &, Options)

Creates a new InterconnectAttachment in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

interconnect_attachment google::cloud::edgenetwork::v1::InterconnectAttachment const &

Required. The resource being created

interconnect_attachment_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and interconnect_attachment_id from the method_signature of Create RPC

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::InterconnectAttachment > >

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.edgenetwork.v1.InterconnectAttachment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInterconnectAttachment(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::edgenetwork::v1::InterconnectAttachment const &, std::string const &, Options)

Creates a new InterconnectAttachment in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
parent std::string const &
interconnect_attachment google::cloud::edgenetwork::v1::InterconnectAttachment const &
interconnect_attachment_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInterconnectAttachment(google::cloud::edgenetwork::v1::CreateInterconnectAttachmentRequest const &, Options)

Creates a new InterconnectAttachment in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::CreateInterconnectAttachmentRequest 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.edgenetwork.v1.CreateInterconnectAttachmentRequest. 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::edgenetwork::v1::InterconnectAttachment > >

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.edgenetwork.v1.InterconnectAttachment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInterconnectAttachment(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::CreateInterconnectAttachmentRequest const &, Options)

Creates a new InterconnectAttachment in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::CreateInterconnectAttachmentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInterconnectAttachment(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a new InterconnectAttachment in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::InterconnectAttachment > >

DeleteInterconnectAttachment(std::string const &, Options)

Deletes a single InterconnectAttachment.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInterconnectAttachment(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a single InterconnectAttachment.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteInterconnectAttachment(google::cloud::edgenetwork::v1::DeleteInterconnectAttachmentRequest const &, Options)

Deletes a single InterconnectAttachment.

Parameters
Name Description
request google::cloud::edgenetwork::v1::DeleteInterconnectAttachmentRequest 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.edgenetwork.v1.DeleteInterconnectAttachmentRequest. 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::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInterconnectAttachment(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::DeleteInterconnectAttachmentRequest const &, Options)

Deletes a single InterconnectAttachment.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::DeleteInterconnectAttachmentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteInterconnectAttachment(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a single InterconnectAttachment.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >

ListRouters(std::string const &, Options)

Lists Routers in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListRoutersRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::edgenetwork::v1::Router >

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.edgenetwork.v1.Router, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRouters(google::cloud::edgenetwork::v1::ListRoutersRequest, Options)

Lists Routers in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::ListRoutersRequest

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.edgenetwork.v1.ListRoutersRequest. 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::edgenetwork::v1::Router >

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.edgenetwork.v1.Router, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetRouter(std::string const &, Options)

Gets details of a single Router.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::Router >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Router) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRouter(google::cloud::edgenetwork::v1::GetRouterRequest const &, Options)

Gets details of a single Router.

Parameters
Name Description
request google::cloud::edgenetwork::v1::GetRouterRequest 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.edgenetwork.v1.GetRouterRequest. 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::edgenetwork::v1::Router >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.Router) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DiagnoseRouter(std::string const &, Options)

Get the diagnostics of a single router resource.

Parameters
Name Description
name std::string const &

Required. The name of the router resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::edgenetwork::v1::DiagnoseRouterResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.DiagnoseRouterResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DiagnoseRouter(google::cloud::edgenetwork::v1::DiagnoseRouterRequest const &, Options)

Get the diagnostics of a single router resource.

Parameters
Name Description
request google::cloud::edgenetwork::v1::DiagnoseRouterRequest 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.edgenetwork.v1.DiagnoseRouterRequest. 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::edgenetwork::v1::DiagnoseRouterResponse >

the result of the RPC. The response message type (google.cloud.edgenetwork.v1.DiagnoseRouterResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateRouter(std::string const &, google::cloud::edgenetwork::v1::Router const &, std::string const &, Options)

Creates a new Router in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

router google::cloud::edgenetwork::v1::Router const &

Required. The resource being created

router_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and router_id from the method_signature of Create RPC

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Router > >

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.edgenetwork.v1.Router proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRouter(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::edgenetwork::v1::Router const &, std::string const &, Options)

Creates a new Router in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
parent std::string const &
router google::cloud::edgenetwork::v1::Router const &
router_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateRouter(google::cloud::edgenetwork::v1::CreateRouterRequest const &, Options)

Creates a new Router in a given project and location.

Parameters
Name Description
request google::cloud::edgenetwork::v1::CreateRouterRequest 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.edgenetwork.v1.CreateRouterRequest. 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::edgenetwork::v1::Router > >

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.edgenetwork.v1.Router proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRouter(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::CreateRouterRequest const &, Options)

Creates a new Router in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::CreateRouterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateRouter(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a new Router in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Router > >

UpdateRouter(google::cloud::edgenetwork::v1::Router const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Router.

Parameters
Name Description
router google::cloud::edgenetwork::v1::Router const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Router resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Router > >

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.edgenetwork.v1.Router proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRouter(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::Router const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Router.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
router google::cloud::edgenetwork::v1::Router const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateRouter(google::cloud::edgenetwork::v1::UpdateRouterRequest const &, Options)

Updates the parameters of a single Router.

Parameters
Name Description
request google::cloud::edgenetwork::v1::UpdateRouterRequest 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.edgenetwork.v1.UpdateRouterRequest. 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::edgenetwork::v1::Router > >

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.edgenetwork.v1.Router proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRouter(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::UpdateRouterRequest const &, Options)

Updates the parameters of a single Router.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::UpdateRouterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateRouter(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the parameters of a single Router.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::Router > >

DeleteRouter(std::string const &, Options)

Deletes a single Router.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRouter(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a single Router.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteRouter(google::cloud::edgenetwork::v1::DeleteRouterRequest const &, Options)

Deletes a single Router.

Parameters
Name Description
request google::cloud::edgenetwork::v1::DeleteRouterRequest 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.edgenetwork.v1.DeleteRouterRequest. 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::edgenetwork::v1::OperationMetadata > >

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.edgenetwork.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRouter(ExperimentalTag, NoAwaitTag, google::cloud::edgenetwork::v1::DeleteRouterRequest const &, Options)

Deletes a single Router.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::edgenetwork::v1::DeleteRouterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteRouter(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a single Router.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::edgenetwork::v1::OperationMetadata > >