BareMetalSolution

import { BareMetalSolution } from "https://googleapis.deno.dev/v1/baremetalsolution:v2.ts";

Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.

class BareMetalSolution {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsInstancesDetachLun(instance: string, req: DetachLunRequest): Promise<Operation>;

async projectsLocationsInstancesDisableHyperthreading(name: string, req: DisableHyperthreadingRequest): Promise<Operation>;

async projectsLocationsInstancesDisableInteractiveSerialConsole(name: string, req: DisableInteractiveSerialConsoleRequest): Promise<Operation>;

async projectsLocationsInstancesEnableHyperthreading(name: string, req: EnableHyperthreadingRequest): Promise<Operation>;

async projectsLocationsInstancesEnableInteractiveSerialConsole(name: string, req: EnableInteractiveSerialConsoleRequest): Promise<Operation>;

async projectsLocationsInstancesGet(name: string): Promise<Instance>;

async projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>;

async projectsLocationsInstancesLoadAuthInfo(name: string): Promise<LoadInstanceAuthInfoResponse>;

async projectsLocationsInstancesPatch(

req: Instance,

opts?: ProjectsLocationsInstancesPatchOptions,

): Promise<Operation>;

async projectsLocationsInstancesReimage(name: string, req: ReimageInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesRename(name: string, req: RenameInstanceRequest): Promise<Instance>;

async projectsLocationsInstancesReset(name: string, req: ResetInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesStart(name: string, req: StartInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesStop(name: string, req: StopInstanceRequest): Promise<Operation>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsNetworksGet(name: string): Promise<Network>;

async projectsLocationsNetworksList(parent: string, opts?: ProjectsLocationsNetworksListOptions): Promise<ListNetworksResponse>;

async projectsLocationsNetworksListNetworkUsage(location: string): Promise<ListNetworkUsageResponse>;

async projectsLocationsNetworksPatch(

req: Network,

opts?: ProjectsLocationsNetworksPatchOptions,

): Promise<Operation>;

async projectsLocationsNetworksRename(name: string, req: RenameNetworkRequest): Promise<Network>;

async projectsLocationsNfsSharesCreate(parent: string, req: NfsShare): Promise<Operation>;

async projectsLocationsNfsSharesDelete(name: string): Promise<Operation>;

async projectsLocationsNfsSharesGet(name: string): Promise<NfsShare>;

async projectsLocationsNfsSharesList(parent: string, opts?: ProjectsLocationsNfsSharesListOptions): Promise<ListNfsSharesResponse>;

async projectsLocationsNfsSharesPatch(

req: NfsShare,

opts?: ProjectsLocationsNfsSharesPatchOptions,

): Promise<Operation>;

async projectsLocationsNfsSharesRename(name: string, req: RenameNfsShareRequest): Promise<NfsShare>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOsImagesGet(name: string): Promise<OSImage>;

async projectsLocationsOsImagesList(parent: string, opts?: ProjectsLocationsOsImagesListOptions): Promise<ListOSImagesResponse>;

async projectsLocationsProvisioningConfigsCreate(

parent: string,

req: ProvisioningConfig,

opts?: ProjectsLocationsProvisioningConfigsCreateOptions,

): Promise<ProvisioningConfig>;

async projectsLocationsProvisioningConfigsGet(name: string): Promise<ProvisioningConfig>;

async projectsLocationsProvisioningConfigsPatch(

req: ProvisioningConfig,

opts?: ProjectsLocationsProvisioningConfigsPatchOptions,

): Promise<ProvisioningConfig>;

async projectsLocationsProvisioningConfigsSubmit(parent: string, req: SubmitProvisioningConfigRequest): Promise<SubmitProvisioningConfigResponse>;

async projectsLocationsProvisioningQuotasList(parent: string, opts?: ProjectsLocationsProvisioningQuotasListOptions): Promise<ListProvisioningQuotasResponse>;

async projectsLocationsSshKeysCreate(

parent: string,

req: SSHKey,

opts?: ProjectsLocationsSshKeysCreateOptions,

): Promise<SSHKey>;

async projectsLocationsSshKeysDelete(name: string): Promise<Empty>;

async projectsLocationsSshKeysList(parent: string, opts?: ProjectsLocationsSshKeysListOptions): Promise<ListSSHKeysResponse>;

async projectsLocationsVolumesEvict(name: string, req: EvictVolumeRequest): Promise<Operation>;

async projectsLocationsVolumesGet(name: string): Promise<Volume>;

async projectsLocationsVolumesList(parent: string, opts?: ProjectsLocationsVolumesListOptions): Promise<ListVolumesResponse>;

async projectsLocationsVolumesLunsEvict(name: string, req: EvictLunRequest): Promise<Operation>;

async projectsLocationsVolumesLunsGet(name: string): Promise<Lun>;

async projectsLocationsVolumesLunsList(parent: string, opts?: ProjectsLocationsVolumesLunsListOptions): Promise<ListLunsResponse>;

async projectsLocationsVolumesPatch(

req: Volume,

opts?: ProjectsLocationsVolumesPatchOptions,

): Promise<Operation>;

async projectsLocationsVolumesRename(name: string, req: RenameVolumeRequest): Promise<Volume>;

async projectsLocationsVolumesResize(volume: string, req: ResizeVolumeRequest): Promise<Operation>;

async projectsLocationsVolumesSnapshotsCreate(parent: string, req: VolumeSnapshot): Promise<VolumeSnapshot>;

async projectsLocationsVolumesSnapshotsDelete(name: string): Promise<Empty>;

async projectsLocationsVolumesSnapshotsGet(name: string): Promise<VolumeSnapshot>;

async projectsLocationsVolumesSnapshotsList(parent: string, opts?: ProjectsLocationsVolumesSnapshotsListOptions): Promise<ListVolumeSnapshotsResponse>;

async projectsLocationsVolumesSnapshotsRestoreVolumeSnapshot(volumeSnapshot: string, req: RestoreVolumeSnapshotRequest): Promise<Operation>;

}

§Constructors

new BareMetalSolution(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsInstancesDetachLun(instance: string, req: DetachLunRequest): Promise<Operation>

[src]

Detach LUN from Instance.

@param instance

Required. Name of the instance.

projectsLocationsInstancesDisableHyperthreading(name: string, req: DisableHyperthreadingRequest): Promise<Operation>

[src]

Perform disable hyperthreading operation on a single server.

@param name

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}

projectsLocationsInstancesDisableInteractiveSerialConsole(name: string, req: DisableInteractiveSerialConsoleRequest): Promise<Operation>

[src]

Disable the interactive serial console feature on an instance.

@param name

Required. Name of the resource.

projectsLocationsInstancesEnableHyperthreading(name: string, req: EnableHyperthreadingRequest): Promise<Operation>

[src]

Perform enable hyperthreading operation on a single server.

@param name

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}

projectsLocationsInstancesEnableInteractiveSerialConsole(name: string, req: EnableInteractiveSerialConsoleRequest): Promise<Operation>

[src]

Enable the interactive serial console feature on an instance.

@param name

Required. Name of the resource.

projectsLocationsInstancesGet(name: string): Promise<Instance>

[src]

Get details about a single server.

@param name

Required. Name of the resource.

projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>

[src]

List servers in a given project and location.

@param parent

Required. Parent value for ListInstancesRequest.

projectsLocationsInstancesLoadAuthInfo(name: string): Promise<LoadInstanceAuthInfoResponse>

[src]

Load auth info for a server.

@param name

Required. Name of the server.

projectsLocationsInstancesPatch(name: string, req: Instance, opts?: ProjectsLocationsInstancesPatchOptions): Promise<Operation>

[src]

Update details of a single server.

@param name

Immutable. The resource name of this Instance. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}

projectsLocationsInstancesReimage(name: string, req: ReimageInstanceRequest): Promise<Operation>

[src]

Perform reimage operation on a single server.

@param name

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}

projectsLocationsInstancesRename(name: string, req: RenameInstanceRequest): Promise<Instance>

[src]

RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.

@param name

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}

projectsLocationsInstancesReset(name: string, req: ResetInstanceRequest): Promise<Operation>

[src]

Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

@param name

Required. Name of the resource.

projectsLocationsInstancesStart(name: string, req: StartInstanceRequest): Promise<Operation>

[src]

Starts a server that was shutdown.

@param name

Required. Name of the resource.

projectsLocationsInstancesStop(name: string, req: StopInstanceRequest): Promise<Operation>

[src]

Stop a running server.

@param name

Required. Name of the resource.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsNetworksGet(name: string): Promise<Network>

[src]

Get details of a single network.

@param name

Required. Name of the resource.

projectsLocationsNetworksList(parent: string, opts?: ProjectsLocationsNetworksListOptions): Promise<ListNetworksResponse>

[src]

List network in a given project and location.

@param parent

Required. Parent value for ListNetworksRequest.

projectsLocationsNetworksListNetworkUsage(location: string): Promise<ListNetworkUsageResponse>

[src]

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

@param location

Required. Parent value (project and location).

projectsLocationsNetworksPatch(name: string, req: Network, opts?: ProjectsLocationsNetworksPatchOptions): Promise<Operation>

[src]

Update details of a single network.

@param name

Output only. The resource name of this Network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/networks/{network}

projectsLocationsNetworksRename(name: string, req: RenameNetworkRequest): Promise<Network>

[src]

RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.

@param name

Required. The name field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network}

projectsLocationsNfsSharesCreate(parent: string, req: NfsShare): Promise<Operation>

[src]

Create an NFS share.

@param parent

Required. The parent project and location.

projectsLocationsNfsSharesDelete(name: string): Promise<Operation>

[src]

Delete an NFS share. The underlying volume is automatically deleted.

@param name

Required. The name of the NFS share to delete.

projectsLocationsNfsSharesGet(name: string): Promise<NfsShare>

[src]

Get details of a single NFS share.

@param name

Required. Name of the resource.

projectsLocationsNfsSharesList(parent: string, opts?: ProjectsLocationsNfsSharesListOptions): Promise<ListNfsSharesResponse>

[src]

List NFS shares.

@param parent

Required. Parent value for ListNfsSharesRequest.

projectsLocationsNfsSharesPatch(name: string, req: NfsShare, opts?: ProjectsLocationsNfsSharesPatchOptions): Promise<Operation>

[src]

Update details of a single NFS share.

@param name

Immutable. The name of the NFS share.

projectsLocationsNfsSharesRename(name: string, req: RenameNfsShareRequest): Promise<NfsShare>

[src]

RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.

@param name

Required. The name field is used to identify the nfsshare. Format: projects/{project}/locations/{location}/nfsshares/{nfsshare}

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Get details about an operation.

@param name

The name of the operation resource.

projectsLocationsOsImagesGet(name: string): Promise<OSImage>

[src]

Get details of a single OS image.

@param name

Required. Name of the OS image.

projectsLocationsOsImagesList(parent: string, opts?: ProjectsLocationsOsImagesListOptions): Promise<ListOSImagesResponse>

[src]

Retrieves the list of OS images which are currently approved.

@param parent

Required. Parent value for ListOSImagesRequest.

projectsLocationsProvisioningConfigsCreate(parent: string, req: ProvisioningConfig, opts?: ProjectsLocationsProvisioningConfigsCreateOptions): Promise<ProvisioningConfig>

[src]

Create new ProvisioningConfig.

@param parent

Required. The parent project and location containing the ProvisioningConfig.

projectsLocationsProvisioningConfigsGet(name: string): Promise<ProvisioningConfig>

[src]

Get ProvisioningConfig by name.

@param name

Required. Name of the ProvisioningConfig.

projectsLocationsProvisioningConfigsPatch(name: string, req: ProvisioningConfig, opts?: ProjectsLocationsProvisioningConfigsPatchOptions): Promise<ProvisioningConfig>

[src]

Update existing ProvisioningConfig.

@param name

Output only. The system-generated name of the provisioning config. This follows the UUID format.

projectsLocationsProvisioningConfigsSubmit(parent: string, req: SubmitProvisioningConfigRequest): Promise<SubmitProvisioningConfigResponse>

[src]

Submit a provisioning configuration for a given project.

@param parent

Required. The parent project and location containing the ProvisioningConfig.

projectsLocationsProvisioningQuotasList(parent: string, opts?: ProjectsLocationsProvisioningQuotasListOptions): Promise<ListProvisioningQuotasResponse>

[src]

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

@param parent

Required. Parent value for ListProvisioningQuotasRequest.

projectsLocationsSshKeysCreate(parent: string, req: SSHKey, opts?: ProjectsLocationsSshKeysCreateOptions): Promise<SSHKey>

[src]

@param parent

Required. The parent containing the SSH keys.

projectsLocationsSshKeysDelete(name: string): Promise<Empty>

[src]

Deletes a public SSH key registered in the specified project.

@param name

Required. The name of the SSH key to delete. Currently, the only valid value for the location is "global".

projectsLocationsSshKeysList(parent: string, opts?: ProjectsLocationsSshKeysListOptions): Promise<ListSSHKeysResponse>

[src]

Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

@param parent

Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".

projectsLocationsVolumesEvict(name: string, req: EvictVolumeRequest): Promise<Operation>

[src]

Skips volume's cooloff and deletes it now. Volume must be in cooloff state.

@param name

Required. The name of the Volume.

projectsLocationsVolumesGet(name: string): Promise<Volume>

[src]

Get details of a single storage volume.

@param name

Required. Name of the resource.

projectsLocationsVolumesList(parent: string, opts?: ProjectsLocationsVolumesListOptions): Promise<ListVolumesResponse>

[src]

List storage volumes in a given project and location.

@param parent

Required. Parent value for ListVolumesRequest.

projectsLocationsVolumesLunsEvict(name: string, req: EvictLunRequest): Promise<Operation>

[src]

Skips lun's cooloff and deletes it now. Lun must be in cooloff state.

@param name

Required. The name of the lun.

projectsLocationsVolumesLunsGet(name: string): Promise<Lun>

[src]

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

@param name

Required. Name of the resource.

projectsLocationsVolumesLunsList(parent: string, opts?: ProjectsLocationsVolumesLunsListOptions): Promise<ListLunsResponse>

[src]

List storage volume luns for given storage volume.

@param parent

Required. Parent value for ListLunsRequest.

projectsLocationsVolumesPatch(name: string, req: Volume, opts?: ProjectsLocationsVolumesPatchOptions): Promise<Operation>

[src]

Update details of a single storage volume.

@param name

Output only. The resource name of this Volume. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/volumes/{volume}

projectsLocationsVolumesRename(name: string, req: RenameVolumeRequest): Promise<Volume>

[src]

RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.

@param name

Required. The name field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}

projectsLocationsVolumesResize(volume: string, req: ResizeVolumeRequest): Promise<Operation>

[src]

Emergency Volume resize.

@param volume

Required. Volume to resize.

projectsLocationsVolumesSnapshotsCreate(parent: string, req: VolumeSnapshot): Promise<VolumeSnapshot>

[src]

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

@param parent

Required. The volume to snapshot.

projectsLocationsVolumesSnapshotsDelete(name: string): Promise<Empty>

[src]

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

@param name

Required. The name of the snapshot to delete.

projectsLocationsVolumesSnapshotsGet(name: string): Promise<VolumeSnapshot>

[src]

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

@param name

Required. The name of the snapshot.

projectsLocationsVolumesSnapshotsList(parent: string, opts?: ProjectsLocationsVolumesSnapshotsListOptions): Promise<ListVolumeSnapshotsResponse>

[src]

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.

@param parent

Required. Parent value for ListVolumesRequest.

projectsLocationsVolumesSnapshotsRestoreVolumeSnapshot(volumeSnapshot: string, req: RestoreVolumeSnapshotRequest): Promise<Operation>

[src]

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

@param volumeSnapshot

Required. Name of the snapshot which will be used to restore its parent volume.