Class BareMetalSolutionClient (2.17.0)

Performs management operations on Bare Metal Solution servers.

The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.

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

BareMetalSolutionClient(BareMetalSolutionClient const &)

Copy and move support

Parameter
Name	Description
	`BareMetalSolutionClient const &`

BareMetalSolutionClient(BareMetalSolutionClient &&)

Copy and move support

Parameter
Name	Description
	`BareMetalSolutionClient &&`

BareMetalSolutionClient(std::shared_ptr< BareMetalSolutionConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< BareMetalSolutionConnection >`
`opts`	`Options`

Operators

operator=(BareMetalSolutionClient const &)

Copy and move support

Parameter
Name	Description
	`BareMetalSolutionClient const &`

Returns
Type	Description
`BareMetalSolutionClient &`

operator=(BareMetalSolutionClient &&)

Copy and move support

Parameter
Name	Description
	`BareMetalSolutionClient &&`

Returns
Type	Description
`BareMetalSolutionClient &`

Functions

ListInstances(std::string const &, Options)

List servers in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListInstancesRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::Instance >

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

ListInstances(google::cloud::baremetalsolution::v2::ListInstancesRequest, Options)

List servers in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListInstancesRequest` 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.baremetalsolution.v2.ListInstancesRequest. 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::baremetalsolution::v2::Instance >

GetInstance(std::string const &, Options)

Get details about a single server.

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::baremetalsolution::v2::Instance >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetInstance(google::cloud::baremetalsolution::v2::GetInstanceRequest const &, Options)

Get details about a single server.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::GetInstanceRequest 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.baremetalsolution.v2.GetInstanceRequest. 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::baremetalsolution::v2::Instance >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateInstance(google::cloud::baremetalsolution::v2::Instance const &, google::protobuf::FieldMask const &, Options)

Update details of a single server.

Parameters
Name	Description
`instance`	`google::cloud::baremetalsolution::v2::Instance const &` Required. The server to update. The `name` field is used to identify the instance to update. Format: projects/{project}/locations/{location}/instances/{instance}
`update_mask`	`google::protobuf::FieldMask const &` The list of fields to update. The currently supported fields are: labels``hyperthreading_enabled``os_image
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::Instance > >

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

UpdateInstance(google::cloud::baremetalsolution::v2::UpdateInstanceRequest const &, Options)

Update details of a single server.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::UpdateInstanceRequest 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.baremetalsolution.v2.UpdateInstanceRequest. 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::baremetalsolution::v2::Instance > >

RenameInstance(std::string const &, std::string const &, Options)

RenameInstance sets a new name for an instance.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`name`	`std::string const &` Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}
`new_instance_id`	`std::string const &` Required. The new `id` of the instance.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::Instance >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameInstance(google::cloud::baremetalsolution::v2::RenameInstanceRequest const &, Options)

RenameInstance sets a new name for an instance.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::RenameInstanceRequest 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.baremetalsolution.v2.RenameInstanceRequest. 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::baremetalsolution::v2::Instance >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ResetInstance(std::string const &, Options)

Perform an ungraceful, hard reset on a server.

Equivalent to shutting the power off and then turning it back on.

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::baremetalsolution::v2::ResetInstanceResponse > >

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

ResetInstance(google::cloud::baremetalsolution::v2::ResetInstanceRequest const &, Options)

Perform an ungraceful, hard reset on a server.

Equivalent to shutting the power off and then turning it back on.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ResetInstanceRequest 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.baremetalsolution.v2.ResetInstanceRequest. 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::baremetalsolution::v2::ResetInstanceResponse > >

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

StartInstance(std::string const &, Options)

Starts a server that was shutdown.

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::baremetalsolution::v2::StartInstanceResponse > >

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

StartInstance(google::cloud::baremetalsolution::v2::StartInstanceRequest const &, Options)

Starts a server that was shutdown.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::StartInstanceRequest 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.baremetalsolution.v2.StartInstanceRequest. 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::baremetalsolution::v2::StartInstanceResponse > >

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

StopInstance(std::string const &, Options)

Stop a running server.

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::baremetalsolution::v2::StopInstanceResponse > >

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

StopInstance(google::cloud::baremetalsolution::v2::StopInstanceRequest const &, Options)

Stop a running server.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::StopInstanceRequest 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.baremetalsolution.v2.StopInstanceRequest. 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::baremetalsolution::v2::StopInstanceResponse > >

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

EnableInteractiveSerialConsole(std::string const &, Options)

Enable the interactive serial console feature on an instance.

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::baremetalsolution::v2::EnableInteractiveSerialConsoleResponse > >

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

EnableInteractiveSerialConsole(google::cloud::baremetalsolution::v2::EnableInteractiveSerialConsoleRequest const &, Options)

Enable the interactive serial console feature on an instance.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::EnableInteractiveSerialConsoleRequest 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.baremetalsolution.v2.EnableInteractiveSerialConsoleRequest. 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::baremetalsolution::v2::EnableInteractiveSerialConsoleResponse > >

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

DisableInteractiveSerialConsole(std::string const &, Options)

Disable the interactive serial console feature on an instance.

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::baremetalsolution::v2::DisableInteractiveSerialConsoleResponse > >

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

DisableInteractiveSerialConsole(google::cloud::baremetalsolution::v2::DisableInteractiveSerialConsoleRequest const &, Options)

Disable the interactive serial console feature on an instance.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::DisableInteractiveSerialConsoleRequest 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.baremetalsolution.v2.DisableInteractiveSerialConsoleRequest. 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::baremetalsolution::v2::DisableInteractiveSerialConsoleResponse > >

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

DetachLun(std::string const &, std::string const &, Options)

Detach LUN from Instance.

Parameters
Name	Description
`instance`	`std::string const &` Required. Name of the instance.
`lun`	`std::string const &` Required. Name of the Lun to detach.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::Instance > >

DetachLun(google::cloud::baremetalsolution::v2::DetachLunRequest const &, Options)

Detach LUN from Instance.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::DetachLunRequest 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.baremetalsolution.v2.DetachLunRequest. 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::baremetalsolution::v2::Instance > >

ListSSHKeys(std::string const &, Options)

Lists the public SSH keys registered for the specified project.

These SSH keys are used only for the interactive serial console feature.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::SSHKey >

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

ListSSHKeys(google::cloud::baremetalsolution::v2::ListSSHKeysRequest, Options)

Lists the public SSH keys registered for the specified project.

These SSH keys are used only for the interactive serial console feature.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListSSHKeysRequest` 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.baremetalsolution.v2.ListSSHKeysRequest. 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::baremetalsolution::v2::SSHKey >

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

CreateSSHKey(std::string const &, google::cloud::baremetalsolution::v2::SSHKey const &, std::string const &, Options)

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent containing the SSH keys.
`ssh_key`	`google::cloud::baremetalsolution::v2::SSHKey const &` Required. The SSH key to register.
`ssh_key_id`	`std::string const &` Required. The ID to use for the key, which will become the final component of the key's resource name. This value must match the regex: [a-zA-Z0-9.-_]{1,64}
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::SSHKey >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.SSHKey) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateSSHKey(google::cloud::baremetalsolution::v2::CreateSSHKeyRequest const &, Options)

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::CreateSSHKeyRequest 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.baremetalsolution.v2.CreateSSHKeyRequest. 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::baremetalsolution::v2::SSHKey >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.SSHKey) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteSSHKey(std::string const &, Options)

Deletes a public SSH key registered in the specified project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the SSH key to delete. Currently, the only valid value for the location is "global".
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteSSHKey(google::cloud::baremetalsolution::v2::DeleteSSHKeyRequest const &, Options)

Deletes a public SSH key registered in the specified project.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::DeleteSSHKeyRequest 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.baremetalsolution.v2.DeleteSSHKeyRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListVolumes(std::string const &, Options)

List storage volumes in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListVolumesRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::Volume >

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

ListVolumes(google::cloud::baremetalsolution::v2::ListVolumesRequest, Options)

List storage volumes in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListVolumesRequest` 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.baremetalsolution.v2.ListVolumesRequest. 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::baremetalsolution::v2::Volume >

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

GetVolume(std::string const &, Options)

Get details of a single storage volume.

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::baremetalsolution::v2::Volume >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Volume) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetVolume(google::cloud::baremetalsolution::v2::GetVolumeRequest const &, Options)

Get details of a single storage volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::GetVolumeRequest 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.baremetalsolution.v2.GetVolumeRequest. 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::baremetalsolution::v2::Volume >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Volume) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateVolume(google::cloud::baremetalsolution::v2::Volume const &, google::protobuf::FieldMask const &, Options)

Update details of a single storage volume.

Parameters
Name	Description
`volume`	`google::cloud::baremetalsolution::v2::Volume const &` Required. The volume to update. The `name` field is used to identify the volume to update. Format: projects/{project}/locations/{location}/volumes/{volume}
`update_mask`	`google::protobuf::FieldMask const &` The list of fields to update. The only currently supported fields are: 'labels'
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::Volume > >

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

UpdateVolume(google::cloud::baremetalsolution::v2::UpdateVolumeRequest const &, Options)

Update details of a single storage volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::UpdateVolumeRequest 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.baremetalsolution.v2.UpdateVolumeRequest. 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::baremetalsolution::v2::Volume > >

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

RenameVolume(std::string const &, std::string const &, Options)

RenameVolume sets a new name for a volume.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`name`	`std::string const &` Required. The `name` field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}
`new_volume_id`	`std::string const &` Required. The new `id` of the volume.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::Volume >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Volume) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameVolume(google::cloud::baremetalsolution::v2::RenameVolumeRequest const &, Options)

RenameVolume sets a new name for a volume.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::RenameVolumeRequest 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.baremetalsolution.v2.RenameVolumeRequest. 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::baremetalsolution::v2::Volume >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Volume) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

EvictVolume(std::string const &, Options)

Skips volume's cooloff and deletes it now.

Volume must be in cooloff state.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the Volume.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::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.baremetalsolution.v2.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

EvictVolume(google::cloud::baremetalsolution::v2::EvictVolumeRequest const &, Options)

Skips volume's cooloff and deletes it now.

Volume must be in cooloff state.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::EvictVolumeRequest 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.baremetalsolution.v2.EvictVolumeRequest. 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::baremetalsolution::v2::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.baremetalsolution.v2.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResizeVolume(std::string const &, std::int64_t, Options)

Emergency Volume resize.

Parameters
Name	Description
`volume`	`std::string const &` Required. Volume to resize.
`size_gib`	`std::int64_t` New Volume size, in GiB.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::Volume > >

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

ResizeVolume(google::cloud::baremetalsolution::v2::ResizeVolumeRequest const &, Options)

Emergency Volume resize.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ResizeVolumeRequest 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.baremetalsolution.v2.ResizeVolumeRequest. 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::baremetalsolution::v2::Volume > >

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

ListNetworks(std::string const &, Options)

List network 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::baremetalsolution::v2::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.baremetalsolution.v2.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::baremetalsolution::v2::ListNetworksRequest, Options)

List network in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::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.baremetalsolution.v2.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::baremetalsolution::v2::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.baremetalsolution.v2.Network, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNetworkUsage(std::string const &, Options)

List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

Parameters
Name	Description
`location`	`std::string const &` Required. Parent value (project and location).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::ListNetworkUsageResponse >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ListNetworkUsageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListNetworkUsage(google::cloud::baremetalsolution::v2::ListNetworkUsageRequest const &, Options)

List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListNetworkUsageRequest 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.baremetalsolution.v2.ListNetworkUsageRequest. 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::baremetalsolution::v2::ListNetworkUsageResponse >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ListNetworkUsageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetNetwork(std::string const &, Options)

Get 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::baremetalsolution::v2::Network >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.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::baremetalsolution::v2::GetNetworkRequest const &, Options)

Get details of a single network.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::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.baremetalsolution.v2.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::baremetalsolution::v2::Network >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Network) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateNetwork(google::cloud::baremetalsolution::v2::Network const &, google::protobuf::FieldMask const &, Options)

Update details of a single network.

Parameters
Name	Description
`network`	`google::cloud::baremetalsolution::v2::Network const &` Required. The network to update. The `name` field is used to identify the instance to update. Format: projects/{project}/locations/{location}/networks/{network}
`update_mask`	`google::protobuf::FieldMask const &` The list of fields to update. The only currently supported fields are: `labels`, `reservations`, `vrf.vlan_attachments`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::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.baremetalsolution.v2.Network proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateNetwork(google::cloud::baremetalsolution::v2::UpdateNetworkRequest const &, Options)

Update details of a single network.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::UpdateNetworkRequest 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.baremetalsolution.v2.UpdateNetworkRequest. 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::baremetalsolution::v2::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.baremetalsolution.v2.Network proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVolumeSnapshot(std::string const &, google::cloud::baremetalsolution::v2::VolumeSnapshot const &, Options)

Takes a snapshot of a boot volume.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`parent`	`std::string const &` Required. The volume to snapshot.
`volume_snapshot`	`google::cloud::baremetalsolution::v2::VolumeSnapshot const &` Required. The snapshot to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::VolumeSnapshot >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.VolumeSnapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateVolumeSnapshot(google::cloud::baremetalsolution::v2::CreateVolumeSnapshotRequest const &, Options)

Takes a snapshot of a boot volume.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::CreateVolumeSnapshotRequest 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.baremetalsolution.v2.CreateVolumeSnapshotRequest. 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::baremetalsolution::v2::VolumeSnapshot >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.VolumeSnapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RestoreVolumeSnapshot(std::string const &, Options)

Uses the specified snapshot to restore its parent volume.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`volume_snapshot`	`std::string const &` Required. Name of the snapshot which will be used to restore its parent volume.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::VolumeSnapshot > >

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

RestoreVolumeSnapshot(google::cloud::baremetalsolution::v2::RestoreVolumeSnapshotRequest const &, Options)

Uses the specified snapshot to restore its parent volume.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::RestoreVolumeSnapshotRequest 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.baremetalsolution.v2.RestoreVolumeSnapshotRequest. 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::baremetalsolution::v2::VolumeSnapshot > >

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

DeleteVolumeSnapshot(std::string const &, Options)

Deletes a volume snapshot.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the snapshot to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteVolumeSnapshot(google::cloud::baremetalsolution::v2::DeleteVolumeSnapshotRequest const &, Options)

Deletes a volume snapshot.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::DeleteVolumeSnapshotRequest 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.baremetalsolution.v2.DeleteVolumeSnapshotRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

GetVolumeSnapshot(std::string const &, Options)

Returns the specified snapshot resource.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the snapshot.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::VolumeSnapshot >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.VolumeSnapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetVolumeSnapshot(google::cloud::baremetalsolution::v2::GetVolumeSnapshotRequest const &, Options)

Returns the specified snapshot resource.

Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::GetVolumeSnapshotRequest 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.baremetalsolution.v2.GetVolumeSnapshotRequest. 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::baremetalsolution::v2::VolumeSnapshot >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.VolumeSnapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListVolumeSnapshots(std::string const &, Options)

Retrieves the list of snapshots for the specified volume.

Returns a response with an empty list of snapshots if called for a non-boot volume.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListVolumesRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::VolumeSnapshot >

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

ListVolumeSnapshots(google::cloud::baremetalsolution::v2::ListVolumeSnapshotsRequest, Options)

Retrieves the list of snapshots for the specified volume.

Returns a response with an empty list of snapshots if called for a non-boot volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListVolumeSnapshotsRequest` 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.baremetalsolution.v2.ListVolumeSnapshotsRequest. 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::baremetalsolution::v2::VolumeSnapshot >

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

GetLun(std::string const &, Options)

Get details of a single storage logical unit number(LUN).

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::baremetalsolution::v2::Lun >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Lun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetLun(google::cloud::baremetalsolution::v2::GetLunRequest const &, Options)

Get details of a single storage logical unit number(LUN).

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::GetLunRequest 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.baremetalsolution.v2.GetLunRequest. 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::baremetalsolution::v2::Lun >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Lun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListLuns(std::string const &, Options)

List storage volume luns for given storage volume.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListLunsRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::Lun >

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

ListLuns(google::cloud::baremetalsolution::v2::ListLunsRequest, Options)

List storage volume luns for given storage volume.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListLunsRequest` 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.baremetalsolution.v2.ListLunsRequest. 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::baremetalsolution::v2::Lun >

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

EvictLun(std::string const &, Options)

Skips lun's cooloff and deletes it now.

Lun must be in cooloff state.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the lun.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::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.baremetalsolution.v2.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

EvictLun(google::cloud::baremetalsolution::v2::EvictLunRequest const &, Options)

Skips lun's cooloff and deletes it now.

Lun must be in cooloff state.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::EvictLunRequest 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.baremetalsolution.v2.EvictLunRequest. 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::baremetalsolution::v2::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.baremetalsolution.v2.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetNfsShare(std::string const &, Options)

Get details of a single NFS share.

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::baremetalsolution::v2::NfsShare >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.NfsShare) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetNfsShare(google::cloud::baremetalsolution::v2::GetNfsShareRequest const &, Options)

Get details of a single NFS share.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::GetNfsShareRequest 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.baremetalsolution.v2.GetNfsShareRequest. 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::baremetalsolution::v2::NfsShare >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.NfsShare) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListNfsShares(std::string const &, Options)

List NFS shares.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListNfsSharesRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::NfsShare >

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

ListNfsShares(google::cloud::baremetalsolution::v2::ListNfsSharesRequest, Options)

List NFS shares.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListNfsSharesRequest` 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.baremetalsolution.v2.ListNfsSharesRequest. 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::baremetalsolution::v2::NfsShare >

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

UpdateNfsShare(google::cloud::baremetalsolution::v2::NfsShare const &, google::protobuf::FieldMask const &, Options)

Update details of a single NFS share.

Parameters
Name	Description
`nfs_share`	`google::cloud::baremetalsolution::v2::NfsShare const &` Required. The NFS share to update. The `name` field is used to identify the NFS share to update. Format: projects/{project}/locations/{location}/nfsShares/{nfs_share}
`update_mask`	`google::protobuf::FieldMask const &` The list of fields to update. The only currently supported fields are: labels``allowed_clients
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::NfsShare > >

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

UpdateNfsShare(google::cloud::baremetalsolution::v2::UpdateNfsShareRequest const &, Options)

Update details of a single NFS share.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::UpdateNfsShareRequest 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.baremetalsolution.v2.UpdateNfsShareRequest. 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::baremetalsolution::v2::NfsShare > >

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

CreateNfsShare(std::string const &, google::cloud::baremetalsolution::v2::NfsShare const &, Options)

Create an NFS share.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent project and location.
`nfs_share`	`google::cloud::baremetalsolution::v2::NfsShare const &` Required. The NfsShare to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::NfsShare > >

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

CreateNfsShare(google::cloud::baremetalsolution::v2::CreateNfsShareRequest const &, Options)

Create an NFS share.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::CreateNfsShareRequest 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.baremetalsolution.v2.CreateNfsShareRequest. 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::baremetalsolution::v2::NfsShare > >

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

RenameNfsShare(std::string const &, std::string const &, Options)

RenameNfsShare sets a new name for an nfsshare.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`name`	`std::string const &` Required. The `name` field is used to identify the nfsshare. Format: projects/{project}/locations/{location}/nfsshares/{nfsshare}
`new_nfsshare_id`	`std::string const &` Required. The new `id` of the nfsshare.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::NfsShare >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.NfsShare) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameNfsShare(google::cloud::baremetalsolution::v2::RenameNfsShareRequest const &, Options)

RenameNfsShare sets a new name for an nfsshare.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::RenameNfsShareRequest 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.baremetalsolution.v2.RenameNfsShareRequest. 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::baremetalsolution::v2::NfsShare >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.NfsShare) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteNfsShare(std::string const &, Options)

Delete an NFS share.

The underlying volume is automatically deleted.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the NFS share to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::baremetalsolution::v2::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.baremetalsolution.v2.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteNfsShare(google::cloud::baremetalsolution::v2::DeleteNfsShareRequest const &, Options)

Delete an NFS share.

The underlying volume is automatically deleted.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::DeleteNfsShareRequest 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.baremetalsolution.v2.DeleteNfsShareRequest. 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::baremetalsolution::v2::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.baremetalsolution.v2.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListProvisioningQuotas(std::string const &, Options)

List the budget details to provision resources on a given project.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListProvisioningQuotasRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::ProvisioningQuota >

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

ListProvisioningQuotas(google::cloud::baremetalsolution::v2::ListProvisioningQuotasRequest, Options)

List the budget details to provision resources on a given project.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListProvisioningQuotasRequest` 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.baremetalsolution.v2.ListProvisioningQuotasRequest. 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::baremetalsolution::v2::ProvisioningQuota >

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

SubmitProvisioningConfig(std::string const &, google::cloud::baremetalsolution::v2::ProvisioningConfig const &, Options)

Submit a provisiong configuration for a given project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent project and location containing the ProvisioningConfig.
`provisioning_config`	`google::cloud::baremetalsolution::v2::ProvisioningConfig const &` Required. The ProvisioningConfig to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::SubmitProvisioningConfigResponse >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.SubmitProvisioningConfigResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SubmitProvisioningConfig(google::cloud::baremetalsolution::v2::SubmitProvisioningConfigRequest const &, Options)

Submit a provisiong configuration for a given project.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::SubmitProvisioningConfigRequest 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.baremetalsolution.v2.SubmitProvisioningConfigRequest. 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::baremetalsolution::v2::SubmitProvisioningConfigResponse >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.SubmitProvisioningConfigResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetProvisioningConfig(std::string const &, Options)

Get ProvisioningConfig by name.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the ProvisioningConfig.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::ProvisioningConfig >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ProvisioningConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetProvisioningConfig(google::cloud::baremetalsolution::v2::GetProvisioningConfigRequest const &, Options)

Get ProvisioningConfig by name.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::GetProvisioningConfigRequest 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.baremetalsolution.v2.GetProvisioningConfigRequest. 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::baremetalsolution::v2::ProvisioningConfig >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ProvisioningConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateProvisioningConfig(std::string const &, google::cloud::baremetalsolution::v2::ProvisioningConfig const &, Options)

Create new ProvisioningConfig.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent project and location containing the ProvisioningConfig.
`provisioning_config`	`google::cloud::baremetalsolution::v2::ProvisioningConfig const &` Required. The ProvisioningConfig to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::ProvisioningConfig >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ProvisioningConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateProvisioningConfig(google::cloud::baremetalsolution::v2::CreateProvisioningConfigRequest const &, Options)

Create new ProvisioningConfig.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::CreateProvisioningConfigRequest 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.baremetalsolution.v2.CreateProvisioningConfigRequest. 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::baremetalsolution::v2::ProvisioningConfig >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ProvisioningConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateProvisioningConfig(google::cloud::baremetalsolution::v2::ProvisioningConfig const &, google::protobuf::FieldMask const &, Options)

Update existing ProvisioningConfig.

Parameters
Name	Description
`provisioning_config`	`google::cloud::baremetalsolution::v2::ProvisioningConfig const &` Required. The ProvisioningConfig to update.
`update_mask`	`google::protobuf::FieldMask const &` Required. The list of fields to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::ProvisioningConfig >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ProvisioningConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateProvisioningConfig(google::cloud::baremetalsolution::v2::UpdateProvisioningConfigRequest const &, Options)

Update existing ProvisioningConfig.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::UpdateProvisioningConfigRequest 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.baremetalsolution.v2.UpdateProvisioningConfigRequest. 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::baremetalsolution::v2::ProvisioningConfig >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.ProvisioningConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameNetwork(std::string const &, std::string const &, Options)

RenameNetwork sets a new name for a network.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`name`	`std::string const &` Required. The `name` field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network}
`new_network_id`	`std::string const &` Required. The new `id` of the network.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::baremetalsolution::v2::Network >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Network) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameNetwork(google::cloud::baremetalsolution::v2::RenameNetworkRequest const &, Options)

RenameNetwork sets a new name for a network.

Use with caution, previous names become immediately invalidated.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::RenameNetworkRequest 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.baremetalsolution.v2.RenameNetworkRequest. 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::baremetalsolution::v2::Network >`	the result of the RPC. The response message type (google.cloud.baremetalsolution.v2.Network) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListOSImages(std::string const &, Options)

Retrieves the list of OS images which are currently approved.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListProvisioningQuotasRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::baremetalsolution::v2::OSImage >

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

ListOSImages(google::cloud::baremetalsolution::v2::ListOSImagesRequest, Options)

Retrieves the list of OS images which are currently approved.

Parameters
Name	Description
`request`	`google::cloud::baremetalsolution::v2::ListOSImagesRequest` 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.baremetalsolution.v2.ListOSImagesRequest. 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::baremetalsolution::v2::OSImage >

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