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 |
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 |
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 |
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 |
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 |
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 |
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. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to update. The currently supported fields are: |
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 |
UpdateInstance(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::Instance const &, google::protobuf::FieldMask const &, Options)
Update details of a single server.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
instance |
google::cloud::baremetalsolution::v2::Instance const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateInstance(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::UpdateInstanceRequest const &, Options)
Update details of a single server.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::UpdateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateInstance(ExperimentalTag, google::longrunning::Operation const &, Options)
Update details of a single server.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::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 |
new_instance_id |
std::string const &
Required. The new |
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 |
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 |
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 |
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 |
ResetInstance(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Perform an ungraceful, hard reset on a server.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
ResetInstance(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::ResetInstanceRequest const &, Options)
Perform an ungraceful, hard reset on a server.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::ResetInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ResetInstance(ExperimentalTag, google::longrunning::Operation const &, Options)
Perform an ungraceful, hard reset on a server.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::ResetInstanceResponse > > |
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 |
StartInstance(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Starts a server that was shutdown.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
StartInstance(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::StartInstanceRequest const &, Options)
Starts a server that was shutdown.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::StartInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StartInstance(ExperimentalTag, google::longrunning::Operation const &, Options)
Starts a server that was shutdown.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::StartInstanceResponse > > |
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 |
StopInstance(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Stop a running server.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
StopInstance(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::StopInstanceRequest const &, Options)
Stop a running server.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::StopInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StopInstance(ExperimentalTag, google::longrunning::Operation const &, Options)
Stop a running server.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::StopInstanceResponse > > |
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 |
EnableInteractiveSerialConsole(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Enable the interactive serial console feature on an instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
EnableInteractiveSerialConsole(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::EnableInteractiveSerialConsoleRequest const &, Options)
Enable the interactive serial console feature on an instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::EnableInteractiveSerialConsoleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
EnableInteractiveSerialConsole(ExperimentalTag, google::longrunning::Operation const &, Options)
Enable the interactive serial console feature on an instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::EnableInteractiveSerialConsoleResponse > > |
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 |
DisableInteractiveSerialConsole(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Disable the interactive serial console feature on an instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DisableInteractiveSerialConsole(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::DisableInteractiveSerialConsoleRequest const &, Options)
Disable the interactive serial console feature on an instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::DisableInteractiveSerialConsoleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DisableInteractiveSerialConsole(ExperimentalTag, google::longrunning::Operation const &, Options)
Disable the interactive serial console feature on an instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::DisableInteractiveSerialConsoleResponse > > |
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 > > |
A |
DetachLun(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, Options)
Detach LUN from Instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
instance |
std::string const &
|
lun |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DetachLun(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::DetachLunRequest const &, Options)
Detach LUN from Instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::DetachLunRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DetachLun(ExperimentalTag, google::longrunning::Operation const &, Options)
Detach LUN from Instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::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 |
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 |
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 |
CreateSSHKey(std::string const &, google::cloud::baremetalsolution::v2::SSHKey const &, std::string const &, Options)
Register a public SSH key in the specified project for use with the interactive serial console feature.
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. |
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 |
CreateSSHKey(google::cloud::baremetalsolution::v2::CreateSSHKeyRequest const &, Options)
Register a public SSH key in the specified project for use with the interactive serial console feature.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::baremetalsolution::v2::CreateSSHKeyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::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 |
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 |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
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 |
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 |
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 |
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 |
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 |
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. |
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 |
UpdateVolume(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::Volume const &, google::protobuf::FieldMask const &, Options)
Update details of a single storage volume.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
volume |
google::cloud::baremetalsolution::v2::Volume const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateVolume(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::UpdateVolumeRequest const &, Options)
Update details of a single storage volume.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::UpdateVolumeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateVolume(ExperimentalTag, google::longrunning::Operation const &, Options)
Update details of a single storage volume.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::Volume > > |
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 |
new_volume_id |
std::string const &
Required. The new |
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 |
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 |
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 |
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 |
EvictVolume(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Skips volume's cooloff and deletes it now.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
EvictVolume(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::EvictVolumeRequest const &, Options)
Skips volume's cooloff and deletes it now.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::EvictVolumeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
EvictVolume(ExperimentalTag, google::longrunning::Operation const &, Options)
Skips volume's cooloff and deletes it now.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::OperationMetadata > > |
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 |
ResizeVolume(ExperimentalTag, NoAwaitTag, std::string const &, std::int64_t, Options)
Emergency Volume resize.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
volume |
std::string const &
|
size_gib |
std::int64_t
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
ResizeVolume(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::ResizeVolumeRequest const &, Options)
Emergency Volume resize.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::ResizeVolumeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ResizeVolume(ExperimentalTag, google::longrunning::Operation const &, Options)
Emergency Volume resize.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::Volume > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to update. The only currently supported fields are: |
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 |
UpdateNetwork(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::Network const &, google::protobuf::FieldMask const &, Options)
Update details of a single network.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
network |
google::cloud::baremetalsolution::v2::Network const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateNetwork(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::UpdateNetworkRequest const &, Options)
Update details of a single network.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::UpdateNetworkRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateNetwork(ExperimentalTag, google::longrunning::Operation const &, Options)
Update details of a single network.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::Network > > |
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 |
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 |
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 |
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 |
RestoreVolumeSnapshot(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Uses the specified snapshot to restore its parent volume.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
volume_snapshot |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
RestoreVolumeSnapshot(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::RestoreVolumeSnapshotRequest const &, Options)
Uses the specified snapshot to restore its parent volume.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::RestoreVolumeSnapshotRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RestoreVolumeSnapshot(ExperimentalTag, google::longrunning::Operation const &, Options)
Uses the specified snapshot to restore its parent volume.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::VolumeSnapshot > > |
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 |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
EvictLun(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Skips lun's cooloff and deletes it now.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
EvictLun(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::EvictLunRequest const &, Options)
Skips lun's cooloff and deletes it now.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::EvictLunRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
EvictLun(ExperimentalTag, google::longrunning::Operation const &, Options)
Skips lun's cooloff and deletes it now.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::OperationMetadata > > |
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 |
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 |
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 |
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 |
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 |
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 |
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. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to update. The only currently supported fields are: |
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 |
UpdateNfsShare(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::NfsShare const &, google::protobuf::FieldMask const &, Options)
Update details of a single NFS share.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
nfs_share |
google::cloud::baremetalsolution::v2::NfsShare const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateNfsShare(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::UpdateNfsShareRequest const &, Options)
Update details of a single NFS share.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::UpdateNfsShareRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateNfsShare(ExperimentalTag, google::longrunning::Operation const &, Options)
Update details of a single NFS share.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::NfsShare > > |
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 |
CreateNfsShare(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::baremetalsolution::v2::NfsShare const &, Options)
Create an NFS share.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
parent |
std::string const &
|
nfs_share |
google::cloud::baremetalsolution::v2::NfsShare const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateNfsShare(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::CreateNfsShareRequest const &, Options)
Create an NFS share.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::CreateNfsShareRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateNfsShare(ExperimentalTag, google::longrunning::Operation const &, Options)
Create an NFS share.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::NfsShare > > |
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 |
new_nfsshare_id |
std::string const &
Required. The new |
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 |
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 |
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 |
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 |
DeleteNfsShare(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Delete an NFS share.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteNfsShare(ExperimentalTag, NoAwaitTag, google::cloud::baremetalsolution::v2::DeleteNfsShareRequest const &, Options)
Delete an NFS share.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::baremetalsolution::v2::DeleteNfsShareRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteNfsShare(ExperimentalTag, google::longrunning::Operation const &, Options)
Delete an NFS share.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::baremetalsolution::v2::OperationMetadata > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
new_network_id |
std::string const &
Required. The new |
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 |
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 |
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 |
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 |
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 |
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 |