Summary of entries of Classes for baremetalsolution.
Classes
BareMetalSolutionAsyncClient
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.
BareMetalSolutionClient
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.
ListInstancesAsyncPager
A pager for iterating through list_instances
requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __aiter__
method to iterate through its
instances
field.
If there are more pages, the __aiter__
method will make additional
ListInstances
requests and continue to iterate
through the instances
field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListInstancesPager
A pager for iterating through list_instances
requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __iter__
method to iterate through its
instances
field.
If there are more pages, the __iter__
method will make additional
ListInstances
requests and continue to iterate
through the instances
field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListLunsAsyncPager
A pager for iterating through list_luns
requests.
This class thinly wraps an initial
ListLunsResponse object, and
provides an __aiter__
method to iterate through its
luns
field.
If there are more pages, the __aiter__
method will make additional
ListLuns
requests and continue to iterate
through the luns
field on the
corresponding responses.
All the usual ListLunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListLunsPager
A pager for iterating through list_luns
requests.
This class thinly wraps an initial
ListLunsResponse object, and
provides an __iter__
method to iterate through its
luns
field.
If there are more pages, the __iter__
method will make additional
ListLuns
requests and continue to iterate
through the luns
field on the
corresponding responses.
All the usual ListLunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListNetworksAsyncPager
A pager for iterating through list_networks
requests.
This class thinly wraps an initial
ListNetworksResponse object, and
provides an __aiter__
method to iterate through its
networks
field.
If there are more pages, the __aiter__
method will make additional
ListNetworks
requests and continue to iterate
through the networks
field on the
corresponding responses.
All the usual ListNetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListNetworksPager
A pager for iterating through list_networks
requests.
This class thinly wraps an initial
ListNetworksResponse object, and
provides an __iter__
method to iterate through its
networks
field.
If there are more pages, the __iter__
method will make additional
ListNetworks
requests and continue to iterate
through the networks
field on the
corresponding responses.
All the usual ListNetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListNfsSharesAsyncPager
A pager for iterating through list_nfs_shares
requests.
This class thinly wraps an initial
ListNfsSharesResponse object, and
provides an __aiter__
method to iterate through its
nfs_shares
field.
If there are more pages, the __aiter__
method will make additional
ListNfsShares
requests and continue to iterate
through the nfs_shares
field on the
corresponding responses.
All the usual ListNfsSharesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListNfsSharesPager
A pager for iterating through list_nfs_shares
requests.
This class thinly wraps an initial
ListNfsSharesResponse object, and
provides an __iter__
method to iterate through its
nfs_shares
field.
If there are more pages, the __iter__
method will make additional
ListNfsShares
requests and continue to iterate
through the nfs_shares
field on the
corresponding responses.
All the usual ListNfsSharesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListOSImagesAsyncPager
A pager for iterating through list_os_images
requests.
This class thinly wraps an initial
ListOSImagesResponse object, and
provides an __aiter__
method to iterate through its
os_images
field.
If there are more pages, the __aiter__
method will make additional
ListOSImages
requests and continue to iterate
through the os_images
field on the
corresponding responses.
All the usual ListOSImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListOSImagesPager
A pager for iterating through list_os_images
requests.
This class thinly wraps an initial
ListOSImagesResponse object, and
provides an __iter__
method to iterate through its
os_images
field.
If there are more pages, the __iter__
method will make additional
ListOSImages
requests and continue to iterate
through the os_images
field on the
corresponding responses.
All the usual ListOSImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListProvisioningQuotasAsyncPager
A pager for iterating through list_provisioning_quotas
requests.
This class thinly wraps an initial
ListProvisioningQuotasResponse object, and
provides an __aiter__
method to iterate through its
provisioning_quotas
field.
If there are more pages, the __aiter__
method will make additional
ListProvisioningQuotas
requests and continue to iterate
through the provisioning_quotas
field on the
corresponding responses.
All the usual ListProvisioningQuotasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListProvisioningQuotasPager
A pager for iterating through list_provisioning_quotas
requests.
This class thinly wraps an initial
ListProvisioningQuotasResponse object, and
provides an __iter__
method to iterate through its
provisioning_quotas
field.
If there are more pages, the __iter__
method will make additional
ListProvisioningQuotas
requests and continue to iterate
through the provisioning_quotas
field on the
corresponding responses.
All the usual ListProvisioningQuotasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSSHKeysAsyncPager
A pager for iterating through list_ssh_keys
requests.
This class thinly wraps an initial
ListSSHKeysResponse object, and
provides an __aiter__
method to iterate through its
ssh_keys
field.
If there are more pages, the __aiter__
method will make additional
ListSSHKeys
requests and continue to iterate
through the ssh_keys
field on the
corresponding responses.
All the usual ListSSHKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSSHKeysPager
A pager for iterating through list_ssh_keys
requests.
This class thinly wraps an initial
ListSSHKeysResponse object, and
provides an __iter__
method to iterate through its
ssh_keys
field.
If there are more pages, the __iter__
method will make additional
ListSSHKeys
requests and continue to iterate
through the ssh_keys
field on the
corresponding responses.
All the usual ListSSHKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListVolumeSnapshotsAsyncPager
A pager for iterating through list_volume_snapshots
requests.
This class thinly wraps an initial
ListVolumeSnapshotsResponse object, and
provides an __aiter__
method to iterate through its
volume_snapshots
field.
If there are more pages, the __aiter__
method will make additional
ListVolumeSnapshots
requests and continue to iterate
through the volume_snapshots
field on the
corresponding responses.
All the usual ListVolumeSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListVolumeSnapshotsPager
A pager for iterating through list_volume_snapshots
requests.
This class thinly wraps an initial
ListVolumeSnapshotsResponse object, and
provides an __iter__
method to iterate through its
volume_snapshots
field.
If there are more pages, the __iter__
method will make additional
ListVolumeSnapshots
requests and continue to iterate
through the volume_snapshots
field on the
corresponding responses.
All the usual ListVolumeSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListVolumesAsyncPager
A pager for iterating through list_volumes
requests.
This class thinly wraps an initial
ListVolumesResponse object, and
provides an __aiter__
method to iterate through its
volumes
field.
If there are more pages, the __aiter__
method will make additional
ListVolumes
requests and continue to iterate
through the volumes
field on the
corresponding responses.
All the usual ListVolumesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListVolumesPager
A pager for iterating through list_volumes
requests.
This class thinly wraps an initial
ListVolumesResponse object, and
provides an __iter__
method to iterate through its
volumes
field.
If there are more pages, the __iter__
method will make additional
ListVolumes
requests and continue to iterate
through the volumes
field on the
corresponding responses.
All the usual ListVolumesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
CreateNfsShareRequest
Message for creating an NFS share.
CreateProvisioningConfigRequest
Request for CreateProvisioningConfig.
CreateSSHKeyRequest
Message for registering a public SSH key in a project.
CreateVolumeSnapshotRequest
Message for creating a volume snapshot.
DeleteNfsShareRequest
Message for deleting an NFS share.
DeleteSSHKeyRequest
Message for deleting an SSH key from a project.
DeleteVolumeSnapshotRequest
Message for deleting named Volume snapshot.
DetachLunRequest
Message for detach specific LUN from an Instance.
DisableInteractiveSerialConsoleRequest
Message for disabling the interactive serial console on an instance.
DisableInteractiveSerialConsoleResponse
Message for response of DisableInteractiveSerialConsole.
EnableInteractiveSerialConsoleRequest
Message for enabling the interactive serial console on an instance.
EnableInteractiveSerialConsoleResponse
Message for response of EnableInteractiveSerialConsole.
EvictLunRequest
Request for skip lun cooloff and delete it.
EvictVolumeRequest
Request for skip volume cooloff and delete it.
GetInstanceRequest
Message for requesting server information.
GetLunRequest
Message for requesting storage lun information.
GetNetworkRequest
Message for requesting network information.
GetNfsShareRequest
Message for requesting NFS share information.
GetProvisioningConfigRequest
Request for GetProvisioningConfig.
GetVolumeRequest
Message for requesting storage volume information.
GetVolumeSnapshotRequest
Message for requesting volume snapshot information.
Instance
A server.
LabelsEntry
The abstract base class for a message.
State
The possible states for this server.
InstanceConfig
Configuration parameters for a new instance.
NetworkAddress
A network.
NetworkConfig
The network configuration of the instance.
InstanceQuota
A resource budget.
ListInstancesRequest
Message for requesting the list of servers.
ListInstancesResponse
Response message for the list of servers.
ListLunsRequest
Message for requesting a list of storage volume luns.
ListLunsResponse
Response message containing the list of storage volume luns.
ListNetworkUsageRequest
Request to get networks with IPs.
ListNetworkUsageResponse
Response with Networks with IPs
ListNetworksRequest
Message for requesting a list of networks.
ListNetworksResponse
Response message containing the list of networks.
ListNfsSharesRequest
Message for requesting a list of NFS shares.
ListNfsSharesResponse
Response message containing the list of NFS shares.
ListOSImagesRequest
Request for getting all available OS images.
ListOSImagesResponse
Request for getting all available OS images.
ListProvisioningQuotasRequest
Message for requesting the list of provisioning quotas.
ListProvisioningQuotasResponse
Response message for the list of provisioning quotas.
ListSSHKeysRequest
Message for listing the public SSH keys in a project.
ListSSHKeysResponse
Message for response of ListSSHKeys.
ListVolumeSnapshotsRequest
Message for requesting a list of volume snapshots.
ListVolumeSnapshotsResponse
Response message containing the list of volume snapshots.
ListVolumesRequest
Message for requesting a list of storage volumes.
ListVolumesResponse
Response message containing the list of storage volumes.
LogicalInterface
Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
LogicalNetworkInterface
Each logical network interface is effectively a network and IP pair.
Lun
A storage volume logical unit number (LUN).
MultiprotocolType
Display the operating systems present for the LUN multiprotocol type.
State
The possible states for the LUN.
StorageType
The storage types for a LUN.
Network
A Network.
LabelsEntry
The abstract base class for a message.
State
The possible states for this Network.
Type
Network type.
NetworkAddressReservation
A reservation of one or more addresses in a network.
NetworkConfig
Configuration parameters for a new network.
Bandwidth
Interconnect bandwidth.
IntakeVlanAttachment
A GCP vlan attachment.
ServiceCidr
Service network block.
Type
Network type.
NetworkMountPoint
Mount point for a network.
NetworkUsage
Network with all used IP addresses.
NfsShare
An NFS share.
AllowedClient
Represents an 'access point' for the share.
LabelsEntry
The abstract base class for a message.
MountPermissions
The possible mount permissions.
State
The possible states for this NFS share.
StorageType
The storage type for a volume.
OSImage
Operation System image.
OperationMetadata
Represents the metadata from a long-running operation.
ProvisioningConfig
A provisioning configuration.
State
The possible states for this ProvisioningConfig.
ProvisioningQuota
A provisioning quota for a given project.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AssetType
The available asset types for intake.
RenameInstanceRequest
Message requesting rename of a server.
RenameNetworkRequest
Message requesting rename of a server.
RenameNfsShareRequest
Message requesting rename of a server.
RenameVolumeRequest
Message requesting rename of a server.
ResetInstanceRequest
Message requesting to reset a server.
ResetInstanceResponse
Response message from resetting a server.
ResizeVolumeRequest
Request for emergency resize Volume.
RestoreVolumeSnapshotRequest
Message for restoring a volume snapshot.
SSHKey
An SSH key, used for authorizing with the interactive serial console feature.
ServerNetworkTemplate
Network template.
LogicalInterface
Logical interface.
InterfaceType
Interface type.
StartInstanceRequest
Message requesting to start a server.
StartInstanceResponse
Response message from starting a server.
StopInstanceRequest
Message requesting to stop a server.
StopInstanceResponse
Response message from stopping a server.
SubmitProvisioningConfigRequest
Request for SubmitProvisioningConfig.
SubmitProvisioningConfigResponse
Response for SubmitProvisioningConfig.
UpdateInstanceRequest
Message requesting to updating a server.
UpdateNetworkRequest
Message requesting to updating a network.
UpdateNfsShareRequest
Message requesting to updating an NFS share.
UpdateProvisioningConfigRequest
Message for updating a ProvisioningConfig.
UpdateVolumeRequest
Message for updating a volume.
VRF
A network VRF.
QosPolicy
QOS policy parameters.
State
The possible states for this VRF.
VlanAttachment
VLAN attachment details.
Volume
A storage volume.
LabelsEntry
The abstract base class for a message.
Protocol
Storage protocol.
SnapshotAutoDeleteBehavior
The kinds of auto delete behavior to use when snapshot reserved space is full.
SnapshotReservationDetail
Details about snapshot space reservation and usage on the storage volume.
State
The possible states for a storage volume.
StorageType
The storage type for a volume.
WorkloadProfile
The possible values for a workload profile.
VolumeConfig
Configuration parameters for a new volume.
LunRange
A LUN(Logical Unit Number) range.
NfsExport
A NFS export entry.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Permissions
Permissions that can granted for an export.
Protocol
The protocol used to access the volume.
Type
The types of Volumes.
VolumePerformanceTier
Performance tier of the Volume.
VolumeSnapshot
A snapshot of a volume. Only boot volumes can have snapshots.
SnapshotType
Represents the type of a snapshot.
WorkloadProfile
The possible values for a workload profile.
Modules
pagers
API documentation for bare_metal_solution_v2.services.bare_metal_solution.pagers
module.