{ "protocol": "rest", "resources": { "projects": { "resources": { "locations": { "resources": { "sshKeys": { "methods": { "list": { "parameters": { "pageSize": { "description": "The maximum number of items to return.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "required": true, "description": "Required. The parent containing the SSH keys. Currently, the only valid value for the location is \"global\".", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "The next_page_token value returned from a previous List request, if any.", "location": "query", "type": "string" } }, "response": { "$ref": "ListSSHKeysResponse" }, "description": "Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "path": "v2/{+parent}/sshKeys", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sshKeys", "id": "baremetalsolution.projects.locations.sshKeys.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "name": { "description": "Required. The name of the SSH key to delete. Currently, the only valid value for the location is \"global\".", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sshKeys/[^/]+$", "required": true } }, "response": { "$ref": "Empty" }, "description": "Deletes a public SSH key registered in the specified project.", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sshKeys/{sshKeysId}", "id": "baremetalsolution.projects.locations.sshKeys.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "path": "v2/{+parent}/sshKeys", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sshKeys", "id": "baremetalsolution.projects.locations.sshKeys.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "description": "Required. The parent containing the SSH keys.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "sshKeyId": { "description": "Required. The ID to use for the key, which will become the final component of the key's resource name. This value must match the regex: [a-zA-Z0-9@.\\-_]{1,64}", "location": "query", "type": "string" } }, "response": { "$ref": "SSHKey" }, "description": "Register a public SSH key in the specified project for use with the interactive serial console feature.", "request": { "$ref": "SSHKey" }, "parameterOrder": [ "parent" ], "httpMethod": "POST" } } }, "networks": { "methods": { "list": { "path": "v2/{+parent}/networks", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/networks", "id": "baremetalsolution.projects.locations.networks.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "description": "Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "description": "List filter.", "location": "query", "type": "string" }, "parent": { "required": true, "description": "Required. Parent value for ListNetworksRequest.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" } }, "response": { "$ref": "ListNetworksResponse" }, "description": "List network in a given project and location.", "parameterOrder": [ "parent" ], "httpMethod": "GET" }, "rename": { "httpMethod": "POST", "request": { "$ref": "RenameNetworkRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "Required. The `name` field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network}", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/networks/[^/]+$" } }, "response": { "$ref": "Network" }, "description": "RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.", "id": "baremetalsolution.projects.locations.networks.rename", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}:rename", "path": "v2/{+name}:rename" }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/networks/[^/]+$", "description": "Required. Name of the resource.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Network" }, "description": "Get details of a single network.", "id": "baremetalsolution.projects.locations.networks.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}", "path": "v2/{+name}" }, "listNetworkUsage": { "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value (project and location).", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "ListNetworkUsageResponse" }, "description": "List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.", "parameterOrder": [ "location" ], "httpMethod": "GET", "path": "v2/{+location}/networks:listNetworkUsage", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/networks:listNetworkUsage", "id": "baremetalsolution.projects.locations.networks.listNetworkUsage", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}", "id": "baremetalsolution.projects.locations.networks.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}", "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "The list of fields to update. The only currently supported fields are: `labels`, `reservations`, `vrf.vlan_attachments`", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/networks/[^/]+$", "description": "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}`", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Update details of a single network.", "request": { "$ref": "Network" }, "parameterOrder": [ "name" ] } } }, "provisioningQuotas": { "methods": { "list": { "id": "baremetalsolution.projects.locations.provisioningQuotas.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/provisioningQuotas", "path": "v2/{+parent}/provisioningQuotas", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default. Notice that page_size field is not supported and won't be respected in the API request for now, will be updated when pagination is supported.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value for ListProvisioningQuotasRequest.", "location": "path", "type": "string" }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" } }, "response": { "$ref": "ListProvisioningQuotasResponse" }, "description": "List the budget details to provision resources on a given project." } } }, "provisioningConfigs": { "methods": { "submit": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent project and location containing the ProvisioningConfig.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "SubmitProvisioningConfigResponse" }, "description": "Submit a provisioning configuration for a given project.", "parameterOrder": [ "parent" ], "request": { "$ref": "SubmitProvisioningConfigRequest" }, "httpMethod": "POST", "path": "v2/{+parent}/provisioningConfigs:submit", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs:submit", "id": "baremetalsolution.projects.locations.provisioningConfigs.submit", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs/{provisioningConfigsId}", "id": "baremetalsolution.projects.locations.provisioningConfigs.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/provisioningConfigs/[^/]+$", "description": "Required. Name of the ProvisioningConfig.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "ProvisioningConfig" }, "description": "Get ProvisioningConfig by name.", "parameterOrder": [ "name" ] }, "create": { "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent project and location containing the ProvisioningConfig.", "location": "path", "type": "string", "required": true }, "email": { "description": "Optional. Email provided to send a confirmation with provisioning config to.", "location": "query", "type": "string" } }, "response": { "$ref": "ProvisioningConfig" }, "description": "Create new ProvisioningConfig.", "request": { "$ref": "ProvisioningConfig" }, "parameterOrder": [ "parent" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs", "id": "baremetalsolution.projects.locations.provisioningConfigs.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+parent}/provisioningConfigs" }, "patch": { "request": { "$ref": "ProvisioningConfig" }, "parameterOrder": [ "name" ], "parameters": { "email": { "description": "Optional. Email provided to send a confirmation with provisioning config to.", "location": "query", "type": "string" }, "updateMask": { "description": "Required. The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/provisioningConfigs/[^/]+$", "description": "Output only. The system-generated name of the provisioning config. This follows the UUID format.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "ProvisioningConfig" }, "description": "Update existing ProvisioningConfig.", "httpMethod": "PATCH", "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.provisioningConfigs.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs/{provisioningConfigsId}" } } }, "instances": { "methods": { "disableHyperthreading": { "httpMethod": "POST", "parameterOrder": [ "name" ], "request": { "$ref": "DisableHyperthreadingRequest" }, "parameters": { "name": { "required": true, "description": "Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Perform disable hyperthreading operation on a single server.", "id": "baremetalsolution.projects.locations.instances.disableHyperthreading", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:disableHyperthreading", "path": "v2/{+name}:disableHyperthreading" }, "enableHyperthreading": { "httpMethod": "POST", "parameterOrder": [ "name" ], "request": { "$ref": "EnableHyperthreadingRequest" }, "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "description": "Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Perform enable hyperthreading operation on a single server.", "id": "baremetalsolution.projects.locations.instances.enableHyperthreading", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:enableHyperthreading", "path": "v2/{+name}:enableHyperthreading" }, "disableInteractiveSerialConsole": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:disableInteractiveSerialConsole", "id": "baremetalsolution.projects.locations.instances.disableInteractiveSerialConsole", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}:disableInteractiveSerialConsole", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "description": "Required. Name of the resource.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Operation" }, "description": "Disable the interactive serial console feature on an instance.", "request": { "$ref": "DisableInteractiveSerialConsoleRequest" }, "parameterOrder": [ "name" ] }, "enableInteractiveSerialConsole": { "request": { "$ref": "EnableInteractiveSerialConsoleRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "description": "Required. Name of the resource.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Operation" }, "description": "Enable the interactive serial console feature on an instance.", "httpMethod": "POST", "path": "v2/{+name}:enableInteractiveSerialConsole", "id": "baremetalsolution.projects.locations.instances.enableInteractiveSerialConsole", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:enableInteractiveSerialConsole" }, "loadAuthInfo": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the server.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "response": { "$ref": "LoadInstanceAuthInfoResponse" }, "description": "Load auth info for a server.", "id": "baremetalsolution.projects.locations.instances.loadAuthInfo", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:loadAuthInfo", "path": "v2/{+name}:loadAuthInfo" }, "start": { "httpMethod": "POST", "parameterOrder": [ "name" ], "request": { "$ref": "StartInstanceRequest" }, "parameters": { "name": { "required": true, "description": "Required. Name of the resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Starts a server that was shutdown.", "id": "baremetalsolution.projects.locations.instances.start", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:start", "path": "v2/{+name}:start" }, "list": { "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value for ListInstancesRequest.", "location": "path", "type": "string" }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" }, "filter": { "description": "List filter.", "location": "query", "type": "string" } }, "response": { "$ref": "ListInstancesResponse" }, "description": "List servers in a given project and location.", "httpMethod": "GET", "path": "v2/{+parent}/instances", "id": "baremetalsolution.projects.locations.instances.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances" }, "rename": { "path": "v2/{+name}:rename", "id": "baremetalsolution.projects.locations.instances.rename", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rename", "parameterOrder": [ "name" ], "request": { "$ref": "RenameInstanceRequest" }, "parameters": { "name": { "required": true, "description": "Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "response": { "$ref": "Instance" }, "description": "RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.", "httpMethod": "POST" }, "get": { "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.instances.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "response": { "$ref": "Instance" }, "description": "Get details about a single server.", "httpMethod": "GET" }, "reset": { "id": "baremetalsolution.projects.locations.instances.reset", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset", "path": "v2/{+name}:reset", "httpMethod": "POST", "request": { "$ref": "ResetInstanceRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "description": "Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on." }, "stop": { "path": "v2/{+name}:stop", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:stop", "id": "baremetalsolution.projects.locations.instances.stop", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "description": "Required. Name of the resource.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Operation" }, "description": "Stop a running server.", "parameterOrder": [ "name" ], "request": { "$ref": "StopInstanceRequest" }, "httpMethod": "POST" }, "detachLun": { "id": "baremetalsolution.projects.locations.instances.detachLun", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:detachLun", "path": "v2/{+instance}:detachLun", "httpMethod": "POST", "request": { "$ref": "DetachLunRequest" }, "parameterOrder": [ "instance" ], "parameters": { "instance": { "required": true, "description": "Required. Name of the instance.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Detach LUN from Instance." }, "patch": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "id": "baremetalsolution.projects.locations.instances.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}", "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "The list of fields to update. The currently supported fields are: `labels` `hyperthreading_enabled` `os_image` `ssh_keys` `kms_key_version`", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "required": true, "description": "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}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Update details of a single server.", "request": { "$ref": "Instance" }, "parameterOrder": [ "name" ] }, "reimage": { "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Perform reimage operation on a single server.", "parameterOrder": [ "name" ], "request": { "$ref": "ReimageInstanceRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reimage", "id": "baremetalsolution.projects.locations.instances.reimage", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}:reimage" } } }, "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/.*$" } }, "response": { "$ref": "Operation" }, "description": "Get details about an operation.", "httpMethod": "GET", "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" } } }, "volumes": { "resources": { "snapshots": { "methods": { "restoreVolumeSnapshot": { "request": { "$ref": "RestoreVolumeSnapshotRequest" }, "parameterOrder": [ "volumeSnapshot" ], "parameters": { "volumeSnapshot": { "description": "Required. Name of the snapshot which will be used to restore its parent volume.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "description": "Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.", "httpMethod": "POST", "path": "v2/{+volumeSnapshot}:restoreVolumeSnapshot", "id": "baremetalsolution.projects.locations.volumes.snapshots.restoreVolumeSnapshot", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}:restoreVolumeSnapshot" }, "get": { "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.volumes.snapshots.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "description": "Required. The name of the snapshot.", "location": "path", "type": "string" } }, "response": { "$ref": "VolumeSnapshot" }, "description": "Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.", "httpMethod": "GET" }, "list": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", "id": "baremetalsolution.projects.locations.volumes.snapshots.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+parent}/snapshots", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "description": "Required. Parent value for ListVolumesRequest.", "location": "path", "type": "string" }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" } }, "response": { "$ref": "ListVolumeSnapshotsResponse" }, "description": "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.", "parameterOrder": [ "parent" ] }, "create": { "httpMethod": "POST", "request": { "$ref": "VolumeSnapshot" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "description": "Required. The volume to snapshot.", "location": "path", "type": "string" } }, "response": { "$ref": "VolumeSnapshot" }, "description": "Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.", "id": "baremetalsolution.projects.locations.volumes.snapshots.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", "path": "v2/{+parent}/snapshots" }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "description": "Required. The name of the snapshot to delete.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Empty" }, "description": "Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.", "id": "baremetalsolution.projects.locations.volumes.snapshots.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", "path": "v2/{+name}" } } }, "luns": { "methods": { "list": { "httpMethod": "GET", "parameters": { "pageSize": { "description": "Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "description": "Required. Parent value for ListLunsRequest.", "location": "path", "type": "string", "required": true }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" } }, "response": { "$ref": "ListLunsResponse" }, "description": "List storage volume luns for given storage volume.", "parameterOrder": [ "parent" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns", "id": "baremetalsolution.projects.locations.volumes.luns.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+parent}/luns" }, "evict": { "path": "v2/{+name}:evict", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns/{lunsId}:evict", "id": "baremetalsolution.projects.locations.volumes.luns.evict", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "Required. The name of the lun.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/luns/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Skips lun's cooloff and deletes it now. Lun must be in cooloff state.", "parameterOrder": [ "name" ], "request": { "$ref": "EvictLunRequest" }, "httpMethod": "POST" }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/luns/[^/]+$", "description": "Required. Name of the resource.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Lun" }, "description": "Get details of a single storage logical unit number(LUN).", "id": "baremetalsolution.projects.locations.volumes.luns.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns/{lunsId}", "path": "v2/{+name}" } } } }, "methods": { "list": { "path": "v2/{+parent}/volumes", "id": "baremetalsolution.projects.locations.volumes.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "description": "Required. Parent value for ListVolumesRequest.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" }, "filter": { "description": "List filter.", "location": "query", "type": "string" }, "pageSize": { "description": "Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" } }, "response": { "$ref": "ListVolumesResponse" }, "description": "List storage volumes in a given project and location.", "httpMethod": "GET" }, "rename": { "httpMethod": "POST", "parameters": { "name": { "description": "Required. The `name` field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true } }, "response": { "$ref": "Volume" }, "description": "RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.", "parameterOrder": [ "name" ], "request": { "$ref": "RenameVolumeRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:rename", "id": "baremetalsolution.projects.locations.volumes.rename", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}:rename" }, "get": { "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", "id": "baremetalsolution.projects.locations.volumes.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "Required. Name of the resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$" } }, "response": { "$ref": "Volume" }, "description": "Get details of a single storage volume.", "parameterOrder": [ "name" ], "httpMethod": "GET" }, "resize": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:resize", "id": "baremetalsolution.projects.locations.volumes.resize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+volume}:resize", "httpMethod": "POST", "parameters": { "volume": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "description": "Required. Volume to resize.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Operation" }, "description": "Emergency Volume resize.", "parameterOrder": [ "volume" ], "request": { "$ref": "ResizeVolumeRequest" } }, "evict": { "httpMethod": "POST", "request": { "$ref": "EvictVolumeRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the Volume.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "description": "Skips volume's cooloff and deletes it now. Volume must be in cooloff state.", "id": "baremetalsolution.projects.locations.volumes.evict", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:evict", "path": "v2/{+name}:evict" }, "patch": { "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.volumes.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", "parameterOrder": [ "name" ], "request": { "$ref": "Volume" }, "parameters": { "name": { "description": "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}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true }, "updateMask": { "description": "The list of fields to update. The only currently supported fields are: 'labels'", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "description": "Update details of a single storage volume.", "httpMethod": "PATCH" } } }, "nfsShares": { "methods": { "delete": { "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.nfsShares.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nfsShares/{nfsSharesId}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the NFS share to delete.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/nfsShares/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "description": "Delete an NFS share. The underlying volume is automatically deleted.", "httpMethod": "DELETE" }, "patch": { "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.nfsShares.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nfsShares/{nfsSharesId}", "request": { "$ref": "NfsShare" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/nfsShares/[^/]+$", "description": "Immutable. The name of the NFS share.", "location": "path", "type": "string" }, "updateMask": { "description": "The list of fields to update. The only currently supported fields are: `labels` `allowed_clients`", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "description": "Update details of a single NFS share.", "httpMethod": "PATCH" }, "create": { "request": { "$ref": "NfsShare" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent project and location.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "description": "Create an NFS share.", "httpMethod": "POST", "path": "v2/{+parent}/nfsShares", "id": "baremetalsolution.projects.locations.nfsShares.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nfsShares" }, "list": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nfsShares", "id": "baremetalsolution.projects.locations.nfsShares.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+parent}/nfsShares", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "description": "List filter.", "location": "query", "type": "string" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value for ListNfsSharesRequest.", "location": "path", "type": "string" }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" } }, "response": { "$ref": "ListNfsSharesResponse" }, "description": "List NFS shares.", "parameterOrder": [ "parent" ] }, "rename": { "id": "baremetalsolution.projects.locations.nfsShares.rename", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nfsShares/{nfsSharesId}:rename", "path": "v2/{+name}:rename", "httpMethod": "POST", "request": { "$ref": "RenameNfsShareRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/nfsShares/[^/]+$", "description": "Required. The `name` field is used to identify the nfsshare. Format: projects/{project}/locations/{location}/nfsshares/{nfsshare}", "location": "path", "type": "string" } }, "response": { "$ref": "NfsShare" }, "description": "RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated." }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/nfsShares/[^/]+$" } }, "response": { "$ref": "NfsShare" }, "description": "Get details of a single NFS share.", "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nfsShares/{nfsSharesId}", "id": "baremetalsolution.projects.locations.nfsShares.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}" } } }, "osImages": { "methods": { "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/osImages/[^/]+$", "description": "Required. Name of the OS image.", "location": "path", "type": "string" } }, "response": { "$ref": "OSImage" }, "description": "Get details of a single OS image.", "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/osImages/{osImagesId}", "id": "baremetalsolution.projects.locations.osImages.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}" }, "list": { "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value for ListOSImagesRequest.", "location": "path", "type": "string", "required": true }, "pageToken": { "description": "A token identifying a page of results from the server.", "location": "query", "type": "string" }, "pageSize": { "description": "Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default. Notice that page_size field is not supported and won't be respected in the API request for now, will be updated when pagination is supported.", "location": "query", "type": "integer", "format": "int32" } }, "response": { "$ref": "ListOSImagesResponse" }, "description": "Retrieves the list of OS images which are currently approved.", "parameterOrder": [ "parent" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/osImages", "id": "baremetalsolution.projects.locations.osImages.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+parent}/osImages" } } } }, "methods": { "list": { "parameters": { "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+$", "description": "The resource that owns the locations collection, if applicable.", "location": "path", "type": "string", "required": true }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "type": "string", "repeated": true }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" } }, "response": { "$ref": "ListLocationsResponse" }, "description": "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.", "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v2/{+name}/locations", "flatPath": "v2/projects/{projectsId}/locations", "id": "baremetalsolution.projects.locations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Resource name for the location.", "location": "path", "type": "string" } }, "response": { "$ref": "Location" }, "description": "Gets information about a location.", "httpMethod": "GET", "path": "v2/{+name}", "id": "baremetalsolution.projects.locations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}" } } } } } }, "batchPath": "batch", "baseUrl": "https://baremetalsolution.googleapis.com/", "ownerDomain": "google.com", "parameters": { "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "default": "true", "type": "boolean", "description": "Returns response with indentations and line breaks.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "location": "query", "enum": [ "json", "media", "proto" ], "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ] } }, "description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "kind": "discovery#restDescription", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "discoveryVersion": "v1", "schemas": { "Instance": { "id": "Instance", "properties": { "osImage": { "description": "The OS image currently installed on the server.", "type": "string" }, "pod": { "description": "Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Update a time stamp.", "type": "string", "format": "google-datetime" }, "firmwareVersion": { "description": "Output only. The firmware version for the instance.", "type": "string", "readOnly": true }, "machineType": { "description": "Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)", "type": "string" }, "workloadProfile": { "enumDescriptions": [ "The workload profile is in an unknown state.", "The workload profile is generic.", "The workload profile is hana." ], "description": "The workload profile for the instance.", "type": "string", "enum": [ "WORKLOAD_PROFILE_UNSPECIFIED", "WORKLOAD_PROFILE_GENERIC", "WORKLOAD_PROFILE_HANA" ] }, "interactiveSerialConsoleEnabled": { "readOnly": true, "description": "Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.", "type": "boolean" }, "networkTemplate": { "description": "Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of \"bond\" or \"nic\".", "type": "string" }, "networks": { "description": "Output only. List of networks associated with this server.", "type": "array", "items": { "$ref": "Network" }, "readOnly": true }, "kmsKeyVersion": { "description": "Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.", "type": "string" }, "sshKeys": { "description": "Optional. List of SSH Keys used during instance provisioning.", "type": "array", "items": { "type": "string" } }, "luns": { "description": "Immutable. List of LUNs associated with this server.", "type": "array", "items": { "$ref": "Lun" } }, "logicalInterfaces": { "description": "List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.", "type": "array", "items": { "$ref": "GoogleCloudBaremetalsolutionV2LogicalInterface" } }, "hyperthreadingEnabled": { "description": "True if you enable hyperthreading for the server, otherwise false. The default value is false.", "type": "boolean" }, "loginInfo": { "readOnly": true, "description": "Output only. Text field about info for logging in.", "type": "string" }, "id": { "readOnly": true, "description": "Output only. An identifier for the `Instance`, generated by the backend.", "type": "string" }, "labels": { "description": "Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "description": "Output only. Create a time stamp.", "type": "string", "format": "google-datetime", "readOnly": true }, "name": { "description": "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}`", "type": "string" }, "state": { "description": "Output only. The state of the server.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "DELETED", "UPDATING", "STARTING", "STOPPING", "SHUTDOWN" ], "readOnly": true, "enumDescriptions": [ "The server is in an unknown state.", "The server is being provisioned.", "The server is running.", "The server has been deleted.", "The server is being updated.", "The server is starting.", "The server is stopping.", "The server is shutdown." ] }, "volumes": { "description": "Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.", "type": "array", "items": { "$ref": "Volume" } } }, "description": "A server.", "type": "object" }, "LogicalNetworkInterface": { "description": "Each logical network interface is effectively a network and IP pair.", "type": "object", "id": "LogicalNetworkInterface", "properties": { "id": { "description": "An identifier for the `Network`, generated by the backend.", "type": "string" }, "defaultGateway": { "description": "Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.", "type": "boolean" }, "networkType": { "enumDescriptions": [ "Unspecified value.", "Client network, a network peered to a Google Cloud VPC.", "Private network, a network local to the Bare Metal Solution environment." ], "description": "Type of network.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "CLIENT", "PRIVATE" ] }, "network": { "description": "Name of the network", "type": "string" }, "ipAddress": { "description": "IP address in the network", "type": "string" } } }, "GoogleCloudBaremetalsolutionV2ServerNetworkTemplateLogicalInterface": { "id": "GoogleCloudBaremetalsolutionV2ServerNetworkTemplateLogicalInterface", "properties": { "name": { "description": "Interface name. This is not a globally unique identifier. Name is unique only inside the ServerNetworkTemplate. This is of syntax or and forms part of the network template name.", "type": "string" }, "type": { "enum": [ "INTERFACE_TYPE_UNSPECIFIED", "BOND", "NIC" ], "description": "Interface type.", "type": "string", "enumDescriptions": [ "Unspecified value.", "Bond interface type.", "NIC interface type." ] }, "required": { "description": "If true, interface must have network connected.", "type": "boolean" } }, "description": "Logical interface.", "type": "object" }, "ReimageInstanceRequest": { "description": "Message requesting to perform reimage operation on a server.", "type": "object", "id": "ReimageInstanceRequest", "properties": { "sshKeys": { "description": "Optional. List of SSH Keys used during reimaging an instance.", "type": "array", "items": { "type": "string" } }, "osImage": { "description": "Required. The OS image code of the image which will be used in the reimage operation.", "type": "string" }, "kmsKeyVersion": { "description": "Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.", "type": "string" } } }, "SubmitProvisioningConfigResponse": { "description": "Response for SubmitProvisioningConfig.", "type": "object", "id": "SubmitProvisioningConfigResponse", "properties": { "provisioningConfig": { "description": "The submitted provisioning config.", "$ref": "ProvisioningConfig" } } }, "VolumeSnapshot": { "properties": { "description": { "description": "The description of the snapshot.", "type": "string" }, "type": { "enumDescriptions": [ "Type is not specified.", "Snapshot was taken manually by user.", "Snapshot was taken automatically as a part of a snapshot schedule." ], "readOnly": true, "enum": [ "SNAPSHOT_TYPE_UNSPECIFIED", "AD_HOC", "SCHEDULED" ], "description": "Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc.", "type": "string" }, "name": { "description": "The name of the snapshot.", "type": "string" }, "createTime": { "description": "Output only. The creation time of the snapshot.", "type": "string", "format": "google-datetime", "readOnly": true }, "id": { "description": "Output only. An identifier for the snapshot, generated by the backend.", "type": "string", "readOnly": true }, "storageVolume": { "description": "Output only. The name of the volume which this snapshot belongs to.", "type": "string", "readOnly": true } }, "id": "VolumeSnapshot", "description": "A snapshot of a volume. Only boot volumes can have snapshots.", "type": "object" }, "Status": { "id": "Status", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object" }, "IntakeVlanAttachment": { "id": "IntakeVlanAttachment", "properties": { "id": { "description": "Identifier of the VLAN attachment.", "type": "string" }, "pairingKey": { "description": "Attachment pairing key.", "type": "string" } }, "description": "A GCP vlan attachment.", "type": "object" }, "VolumeConfig": { "properties": { "protocol": { "enumDescriptions": [ "Unspecified value.", "Fibre channel.", "Network file system." ], "enum": [ "PROTOCOL_UNSPECIFIED", "PROTOCOL_FC", "PROTOCOL_NFS" ], "description": "Volume protocol.", "type": "string" }, "gcpService": { "description": "The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.", "type": "string" }, "machineIds": { "description": "Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.", "type": "array", "items": { "type": "string" } }, "nfsExports": { "description": "NFS exports. Set only when protocol is PROTOCOL_NFS.", "type": "array", "items": { "$ref": "NfsExport" } }, "lunRanges": { "description": "LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.", "type": "array", "items": { "$ref": "LunRange" } }, "id": { "description": "A transient unique identifier to identify a volume within an ProvisioningConfig request.", "type": "string" }, "userNote": { "description": "User note field, it can be used by customers to add additional information for the BMS Ops team .", "type": "string" }, "name": { "readOnly": true, "description": "Output only. The name of the volume config.", "type": "string" }, "snapshotsEnabled": { "description": "Whether snapshots should be enabled.", "type": "boolean" }, "performanceTier": { "enum": [ "VOLUME_PERFORMANCE_TIER_UNSPECIFIED", "VOLUME_PERFORMANCE_TIER_SHARED", "VOLUME_PERFORMANCE_TIER_ASSIGNED", "VOLUME_PERFORMANCE_TIER_HT", "VOLUME_PERFORMANCE_TIER_QOS2_PERFORMANCE" ], "description": "Performance tier of the Volume. Default is SHARED.", "type": "string", "enumDescriptions": [ "Value is not specified.", "Regular volumes, shared aggregates.", "Assigned aggregates.", "High throughput aggregates.", "QoS 2.0 high performance storage." ] }, "type": { "description": "The type of this Volume.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "FLASH", "DISK" ], "enumDescriptions": [ "The unspecified type.", "This Volume is on flash.", "This Volume is on disk." ] }, "sizeGb": { "description": "The requested size of this volume, in GB.", "type": "integer", "format": "int32" } }, "id": "VolumeConfig", "description": "Configuration parameters for a new volume.", "type": "object" }, "ResetInstanceResponse": { "properties": {}, "id": "ResetInstanceResponse", "description": "Response message from resetting a server.", "type": "object" }, "RestoreVolumeSnapshotRequest": { "description": "Message for restoring a volume snapshot.", "type": "object", "id": "RestoreVolumeSnapshotRequest", "properties": {} }, "OSImage": { "properties": { "supportedNetworkTemplates": { "description": "Network templates that can be used with this OS Image.", "type": "array", "items": { "type": "string" } }, "code": { "description": "OS Image code.", "type": "string" }, "description": { "description": "OS Image description.", "type": "string" }, "applicableInstanceTypes": { "description": "Instance types this image is applicable to. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)", "type": "array", "items": { "type": "string" } }, "name": { "description": "Output only. OS Image's unique name.", "type": "string", "readOnly": true } }, "id": "OSImage", "description": "Operation System image.", "type": "object" }, "StartInstanceResponse": { "properties": {}, "id": "StartInstanceResponse", "description": "Response message from starting a server.", "type": "object" }, "Operation": { "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object" }, "ServerNetworkTemplate": { "id": "ServerNetworkTemplate", "properties": { "name": { "readOnly": true, "description": "Output only. Template's unique name. The full resource name follows the pattern: `projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}` Generally, the {server_network_template} follows the syntax of \"bond\" or \"nic\".", "type": "string" }, "applicableInstanceTypes": { "description": "Instance types this template is applicable to.", "type": "array", "items": { "type": "string" } }, "logicalInterfaces": { "description": "Logical interfaces.", "type": "array", "items": { "$ref": "GoogleCloudBaremetalsolutionV2ServerNetworkTemplateLogicalInterface" } } }, "description": "Network template.", "type": "object" }, "EnableInteractiveSerialConsoleResponse": { "id": "EnableInteractiveSerialConsoleResponse", "properties": {}, "description": "Message for response of EnableInteractiveSerialConsole.", "type": "object" }, "ListNetworksResponse": { "properties": { "networks": { "description": "The list of networks.", "type": "array", "items": { "$ref": "Network" } }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results from the server.", "type": "string" } }, "id": "ListNetworksResponse", "description": "Response message containing the list of networks.", "type": "object" }, "ListLunsResponse": { "properties": { "luns": { "description": "The list of luns.", "type": "array", "items": { "$ref": "Lun" } }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results from the server.", "type": "string" } }, "id": "ListLunsResponse", "description": "Response message containing the list of storage volume luns.", "type": "object" }, "NfsExport": { "description": "A NFS export entry.", "type": "object", "id": "NfsExport", "properties": { "networkId": { "description": "Network to use to publish the export.", "type": "string" }, "noRootSquash": { "description": "Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.", "type": "boolean" }, "permissions": { "enumDescriptions": [ "Unspecified value.", "Read-only permission.", "Read-write permission." ], "enum": [ "PERMISSIONS_UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "description": "Export permissions.", "type": "string" }, "allowDev": { "description": "Allow dev flag in NfsShare AllowedClientsRequest.", "type": "boolean" }, "machineId": { "description": "Either a single machine, identified by an ID, or a comma-separated list of machine IDs.", "type": "string" }, "cidr": { "description": "A CIDR range.", "type": "string" }, "allowSuid": { "description": "Allow the setuid flag.", "type": "boolean" } } }, "EvictVolumeRequest": { "description": "Request for skip volume cooloff and delete it.", "type": "object", "id": "EvictVolumeRequest", "properties": {} }, "StartInstanceRequest": { "properties": {}, "id": "StartInstanceRequest", "description": "Message requesting to start a server.", "type": "object" }, "Lun": { "description": "A storage volume logical unit number (LUN).", "type": "object", "properties": { "instances": { "readOnly": true, "description": "Output only. Instances this Lun is attached to.", "type": "array", "items": { "type": "string" } }, "expireTime": { "description": "Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.", "type": "string", "format": "google-datetime", "readOnly": true }, "shareable": { "description": "Display if this LUN can be shared between multiple physical servers.", "type": "boolean" }, "storageType": { "description": "The storage type for this LUN.", "type": "string", "enum": [ "STORAGE_TYPE_UNSPECIFIED", "SSD", "HDD" ], "enumDescriptions": [ "The storage type for this LUN is unknown.", "This storage type for this LUN is SSD.", "This storage type for this LUN is HDD." ] }, "bootLun": { "description": "Display if this LUN is a boot LUN.", "type": "boolean" }, "sizeGb": { "description": "The size of this LUN, in GiB.", "type": "string", "format": "int64" }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "UPDATING", "READY", "DELETING", "COOL_OFF" ], "description": "The state of this storage volume.", "type": "string", "enumDescriptions": [ "The LUN is in an unknown state.", "The LUN is being created.", "The LUN is being updated.", "The LUN is ready for use.", "The LUN has been requested to be deleted.", "The LUN is in cool off state. It will be deleted after `expire_time`." ] }, "multiprotocolType": { "enum": [ "MULTIPROTOCOL_TYPE_UNSPECIFIED", "LINUX" ], "description": "The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.", "type": "string", "enumDescriptions": [ "Server has no OS specified.", "Server with Linux OS." ] }, "name": { "description": "Output only. The name of the LUN.", "type": "string", "readOnly": true }, "wwid": { "description": "The WWID for this LUN.", "type": "string" }, "id": { "description": "An identifier for the LUN, generated by the backend.", "type": "string" }, "storageVolume": { "description": "Display the storage volume for this LUN.", "type": "string" } }, "id": "Lun" }, "NetworkAddressReservation": { "id": "NetworkAddressReservation", "properties": { "startAddress": { "description": "The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.", "type": "string" }, "endAddress": { "description": "The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.", "type": "string" }, "note": { "description": "A note about this reservation, intended for human consumption.", "type": "string" } }, "description": "A reservation of one or more addresses in a network.", "type": "object" }, "ListNetworkUsageResponse": { "description": "Response with Networks with IPs", "type": "object", "properties": { "networks": { "description": "Networks with IPs.", "type": "array", "items": { "$ref": "NetworkUsage" } } }, "id": "ListNetworkUsageResponse" }, "RenameNfsShareRequest": { "properties": { "newNfsshareId": { "description": "Required. The new `id` of the nfsshare.", "type": "string" } }, "id": "RenameNfsShareRequest", "description": "Message requesting rename of a server.", "type": "object" }, "InstanceQuota": { "description": "A resource budget.", "type": "object", "properties": { "gcpService": { "description": "The gcp service of the provisioning quota.", "type": "string" }, "name": { "readOnly": true, "description": "Output only. The name of the instance quota.", "type": "string" }, "instanceType": { "description": "Instance type. Deprecated: use gcp_service.", "type": "string", "deprecated": true }, "availableMachineCount": { "description": "Number of machines than can be created for the given location and instance_type.", "type": "integer", "format": "int32" }, "location": { "description": "Location where the quota applies.", "type": "string" } }, "id": "InstanceQuota" }, "Volume": { "description": "A storage volume.", "type": "object", "properties": { "emergencySizeGib": { "description": "Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.", "type": "string", "format": "int64" }, "attached": { "description": "Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well.", "type": "boolean", "readOnly": true }, "snapshotAutoDeleteBehavior": { "enumDescriptions": [ "The unspecified behavior.", "Don't delete any snapshots. This disables new snapshot creation, as long as the snapshot reserved space is full.", "Delete the oldest snapshots first.", "Delete the newest snapshots first." ], "description": "The behavior to use when snapshot reserved space is full.", "type": "string", "enum": [ "SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED", "DISABLED", "OLDEST_FIRST", "NEWEST_FIRST" ] }, "autoGrownSizeGib": { "description": "The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.", "type": "string", "format": "int64" }, "workloadProfile": { "enum": [ "WORKLOAD_PROFILE_UNSPECIFIED", "GENERIC", "HANA" ], "description": "The workload profile for the volume.", "type": "string", "enumDescriptions": [ "The workload profile is in an unknown state.", "The workload profile is generic.", "The workload profile is hana." ] }, "originallyRequestedSizeGib": { "description": "Originally requested size, in GiB.", "type": "string", "format": "int64" }, "snapshotReservationDetail": { "description": "Details about snapshot space reservation and usage on the storage volume.", "$ref": "SnapshotReservationDetail" }, "pod": { "description": "Immutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.", "type": "string" }, "storageType": { "description": "The storage type for this volume.", "type": "string", "enum": [ "STORAGE_TYPE_UNSPECIFIED", "SSD", "HDD" ], "enumDescriptions": [ "The storage type for this volume is unknown.", "The storage type for this volume is SSD.", "This storage type for this volume is HDD." ] }, "requestedSizeGib": { "description": "The requested size of this storage volume, in GiB.", "type": "string", "format": "int64" }, "remainingSpaceGib": { "description": "The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.", "type": "string", "format": "int64" }, "expireTime": { "description": "Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.", "type": "string", "format": "google-datetime", "readOnly": true }, "currentSizeGib": { "description": "The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.", "type": "string", "format": "int64" }, "id": { "description": "An identifier for the `Volume`, generated by the backend.", "type": "string" }, "labels": { "description": "Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "readOnly": true, "description": "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}`", "type": "string" }, "performanceTier": { "description": "Immutable. Performance tier of the Volume. Default is SHARED.", "type": "string", "enum": [ "VOLUME_PERFORMANCE_TIER_UNSPECIFIED", "VOLUME_PERFORMANCE_TIER_SHARED", "VOLUME_PERFORMANCE_TIER_ASSIGNED", "VOLUME_PERFORMANCE_TIER_HT", "VOLUME_PERFORMANCE_TIER_QOS2_PERFORMANCE" ], "enumDescriptions": [ "Value is not specified.", "Regular volumes, shared aggregates.", "Assigned aggregates.", "High throughput aggregates.", "QoS 2.0 high performance storage." ] }, "state": { "enumDescriptions": [ "The storage volume is in an unknown state.", "The storage volume is being created.", "The storage volume is ready for use.", "The storage volume has been requested to be deleted.", "The storage volume is being updated.", "The storage volume is in cool off state. It will be deleted after `expire_time`." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING", "UPDATING", "COOL_OFF" ], "description": "The state of this storage volume.", "type": "string" }, "snapshotEnabled": { "description": "Whether snapshots are enabled.", "type": "boolean" }, "bootVolume": { "readOnly": true, "description": "Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.", "type": "boolean" }, "notes": { "description": "Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.", "type": "string" }, "maxSizeGib": { "description": "Maximum size volume can be expanded to in case of evergency, in GiB.", "type": "string", "format": "int64" }, "protocol": { "readOnly": true, "enumDescriptions": [ "Value is not specified.", "Fibre Channel protocol.", "NFS protocol means Volume is a NFS Share volume. Such volumes cannot be manipulated via Volumes API." ], "enum": [ "PROTOCOL_UNSPECIFIED", "FIBRE_CHANNEL", "NFS" ], "description": "Output only. Storage protocol for the Volume.", "type": "string" }, "instances": { "readOnly": true, "description": "Output only. Instances this Volume is attached to. This field is set only in Get requests.", "type": "array", "items": { "type": "string" } } }, "id": "Volume" }, "NetworkMountPoint": { "description": "Mount point for a network.", "type": "object", "id": "NetworkMountPoint", "properties": { "instance": { "description": "Instance to attach network to.", "type": "string" }, "logicalInterface": { "description": "Logical interface to detach from.", "type": "string" }, "ipAddress": { "description": "Ip address of the server.", "type": "string" }, "defaultGateway": { "description": "Network should be a default gateway.", "type": "boolean" } } }, "StopInstanceRequest": { "description": "Message requesting to stop a server.", "type": "object", "properties": {}, "id": "StopInstanceRequest" }, "UserAccount": { "properties": { "encryptedPassword": { "description": "Encrypted initial password value.", "type": "string" }, "kmsKeyVersion": { "description": "KMS CryptoKey Version used to encrypt the password.", "type": "string" } }, "id": "UserAccount", "description": "User account provisioned for the customer.", "type": "object" }, "EnableHyperthreadingRequest": { "description": "Message requesting to perform enable hyperthreading operation on a server.", "type": "object", "id": "EnableHyperthreadingRequest", "properties": {} }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "ListLocationsResponse" }, "DisableHyperthreadingRequest": { "properties": {}, "id": "DisableHyperthreadingRequest", "description": "Message requesting to perform disable hyperthreading operation on a server.", "type": "object" }, "DetachLunRequest": { "description": "Message for detach specific LUN from an Instance.", "type": "object", "properties": { "skipReboot": { "description": "If true, performs lun unmapping without instance reboot.", "type": "boolean" }, "lun": { "description": "Required. Name of the Lun to detach.", "type": "string" } }, "id": "DetachLunRequest" }, "SnapshotReservationDetail": { "id": "SnapshotReservationDetail", "properties": { "reservedSpaceUsedPercent": { "description": "The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.", "type": "integer", "format": "int32" }, "reservedSpaceRemainingGib": { "description": "The amount, in GiB, of available space in this storage volume's reserved snapshot space.", "type": "string", "format": "int64" }, "reservedSpacePercent": { "description": "Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true.", "type": "integer", "format": "int32" }, "reservedSpaceGib": { "description": "The space on this storage volume reserved for snapshots, shown in GiB.", "type": "string", "format": "int64" } }, "description": "Details about snapshot space reservation and usage on the storage volume.", "type": "object" }, "NetworkAddress": { "description": "A network.", "type": "object", "properties": { "networkId": { "description": "Id of the network to use, within the same ProvisioningConfig request.", "type": "string" }, "address": { "description": "IPv4 address to be assigned to the server.", "type": "string" }, "existingNetworkId": { "description": "Name of the existing network to use.", "type": "string" } }, "id": "NetworkAddress" }, "Location": { "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } }, "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object" }, "Network": { "id": "Network", "properties": { "macAddress": { "description": "List of physical interfaces.", "type": "array", "items": { "type": "string" } }, "state": { "description": "The Network state.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "PROVISIONED", "DEPROVISIONING", "UPDATING" ], "enumDescriptions": [ "The Network is in an unknown state.", "The Network is provisioning.", "The Network has been provisioned.", "The Network is being deprovisioned.", "The Network is being updated." ] }, "vrf": { "description": "The Vrf for the Network. Use this only if a new Vrf needs to be created.", "$ref": "VRF" }, "reservations": { "description": "List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.", "type": "array", "items": { "$ref": "NetworkAddressReservation" } }, "servicesCidr": { "description": "IP range for reserved for services (e.g. NFS).", "type": "string" }, "id": { "description": "An identifier for the `Network`, generated by the backend.", "type": "string" }, "cidr": { "description": "The cidr of the Network.", "type": "string" }, "labels": { "description": "Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "readOnly": true, "description": "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}`", "type": "string" }, "ipAddress": { "description": "IP address configured.", "type": "string" }, "gatewayIp": { "readOnly": true, "description": "Output only. Gateway ip address.", "type": "string" }, "mountPoints": { "description": "Input only. List of mount points to attach the network to.", "type": "array", "items": { "$ref": "NetworkMountPoint" } }, "jumboFramesEnabled": { "description": "Whether network uses standard frames or jumbo ones.", "type": "boolean" }, "type": { "description": "The type of this network.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "CLIENT", "PRIVATE" ], "enumDescriptions": [ "Unspecified value.", "Client network, a network peered to a Google Cloud VPC.", "Private network, a network local to the Bare Metal Solution environment." ] }, "vlanId": { "description": "The vlan id of the Network.", "type": "string" }, "vrfAttachment": { "description": "Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.", "type": "string" }, "pod": { "description": "Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.", "type": "string" } }, "description": "A Network.", "type": "object" }, "ListVolumeSnapshotsResponse": { "id": "ListVolumeSnapshotsResponse", "properties": { "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results from the server.", "type": "string" }, "volumeSnapshots": { "description": "The list of snapshots.", "type": "array", "items": { "$ref": "VolumeSnapshot" } } }, "description": "Response message containing the list of volume snapshots.", "type": "object" }, "ListOSImagesResponse": { "properties": { "osImages": { "description": "The OS images available.", "type": "array", "items": { "$ref": "OSImage" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "id": "ListOSImagesResponse", "description": "Request for getting all available OS images.", "type": "object" }, "SSHKey": { "properties": { "name": { "readOnly": true, "description": "Output only. The name of this SSH key. Currently, the only valid value for the location is \"global\".", "type": "string" }, "publicKey": { "description": "The public SSH key. This must be in OpenSSH .authorized_keys format.", "type": "string" } }, "id": "SSHKey", "description": "An SSH key, used for authorizing with the interactive serial console feature.", "type": "object" }, "SubmitProvisioningConfigRequest": { "properties": { "provisioningConfig": { "description": "Required. The ProvisioningConfig to create.", "$ref": "ProvisioningConfig" }, "email": { "description": "Optional. Email provided to send a confirmation with provisioning config to.", "type": "string" } }, "id": "SubmitProvisioningConfigRequest", "description": "Request for SubmitProvisioningConfig.", "type": "object" }, "RenameNetworkRequest": { "properties": { "newNetworkId": { "description": "Required. The new `id` of the network.", "type": "string" } }, "id": "RenameNetworkRequest", "description": "Message requesting rename of a server.", "type": "object" }, "EnableInteractiveSerialConsoleRequest": { "description": "Message for enabling the interactive serial console on an instance.", "type": "object", "id": "EnableInteractiveSerialConsoleRequest", "properties": {} }, "ListSSHKeysResponse": { "description": "Message for response of ListSSHKeys.", "type": "object", "id": "ListSSHKeysResponse", "properties": { "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "sshKeys": { "description": "The SSH keys registered in the project.", "type": "array", "items": { "$ref": "SSHKey" } } } }, "NetworkUsage": { "description": "Network with all used IP addresses.", "type": "object", "properties": { "usedIps": { "description": "All used IP addresses in this network.", "type": "array", "items": { "type": "string" } }, "network": { "description": "Network.", "$ref": "Network" } }, "id": "NetworkUsage" }, "AllowedClient": { "properties": { "mountPermissions": { "enum": [ "MOUNT_PERMISSIONS_UNSPECIFIED", "READ", "READ_WRITE" ], "description": "Mount permissions.", "type": "string", "enumDescriptions": [ "Permissions were not specified.", "NFS share can be mount with read-only permissions.", "NFS share can be mount with read-write permissions." ] }, "allowDev": { "description": "Allow dev flag. Which controls whether to allow creation of devices.", "type": "boolean" }, "shareIp": { "description": "Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's services_cidr.", "type": "string", "readOnly": true }, "allowSuid": { "description": "Allow the setuid flag.", "type": "boolean" }, "nfsPath": { "readOnly": true, "description": "Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like \"10.0.0.0:/g123456789-nfs001\"", "type": "string" }, "network": { "description": "The network the access point sits on.", "type": "string" }, "allowedClientsCidr": { "description": "The subnet of IP addresses permitted to access the share.", "type": "string" }, "noRootSquash": { "description": "Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.", "type": "boolean" } }, "id": "AllowedClient", "description": "Represents an 'access point' for the share.", "type": "object" }, "NfsShare": { "description": "An NFS share.", "type": "object", "properties": { "requestedSizeGib": { "description": "The requested size, in GiB.", "type": "string", "format": "int64" }, "storageType": { "enum": [ "STORAGE_TYPE_UNSPECIFIED", "SSD", "HDD" ], "description": "Immutable. The storage type of the underlying volume.", "type": "string", "enumDescriptions": [ "The storage type for this volume is unknown.", "The storage type for this volume is SSD.", "This storage type for this volume is HDD." ] }, "pod": { "description": "Immutable. Pod name. Pod is an independent part of infrastructure. NFSShare can only be connected to the assets (networks, instances) allocated in the same pod.", "type": "string" }, "allowedClients": { "description": "List of allowed access points.", "type": "array", "items": { "$ref": "AllowedClient" } }, "name": { "description": "Immutable. The name of the NFS share.", "type": "string" }, "volume": { "readOnly": true, "description": "Output only. The underlying volume of the share. Created automatically during provisioning.", "type": "string" }, "id": { "description": "Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.", "type": "string", "readOnly": true }, "labels": { "description": "Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "nfsShareId": { "readOnly": true, "description": "Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead.", "type": "string" }, "state": { "enumDescriptions": [ "The share is in an unknown state.", "The share has been provisioned.", "The NFS Share is being created.", "The NFS Share is being updated.", "The NFS Share has been requested to be deleted." ], "readOnly": true, "description": "Output only. The state of the NFS share.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROVISIONED", "CREATING", "UPDATING", "DELETING" ] } }, "id": "NfsShare" }, "GoogleCloudBaremetalsolutionV2LogicalInterface": { "description": "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.", "type": "object", "properties": { "interfaceIndex": { "description": "The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.", "type": "integer", "format": "int32", "deprecated": true }, "logicalNetworkInterfaces": { "description": "List of logical network interfaces within a logical interface.", "type": "array", "items": { "$ref": "LogicalNetworkInterface" } }, "name": { "description": "Interface name. This is of syntax or and forms part of the network template name.", "type": "string" } }, "id": "GoogleCloudBaremetalsolutionV2LogicalInterface" }, "EvictLunRequest": { "description": "Request for skip lun cooloff and delete it.", "type": "object", "id": "EvictLunRequest", "properties": {} }, "RenameVolumeRequest": { "id": "RenameVolumeRequest", "properties": { "newVolumeId": { "description": "Required. The new `id` of the volume.", "type": "string" } }, "description": "Message requesting rename of a server.", "type": "object" }, "ListInstancesResponse": { "properties": { "instances": { "description": "The list of servers.", "type": "array", "items": { "$ref": "Instance" } }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results from the server.", "type": "string" } }, "id": "ListInstancesResponse", "description": "Response message for the list of servers.", "type": "object" }, "ProvisioningConfig": { "properties": { "networks": { "description": "Networks to be created.", "type": "array", "items": { "$ref": "NetworkConfig" } }, "customId": { "description": "Optional. The user-defined identifier of the provisioning config.", "type": "string" }, "instances": { "description": "Instances to be created.", "type": "array", "items": { "$ref": "InstanceConfig" } }, "statusMessage": { "description": "Optional status messages associated with the FAILED state.", "type": "string" }, "cloudConsoleUri": { "description": "Output only. URI to Cloud Console UI view of this provisioning config.", "type": "string", "readOnly": true }, "name": { "readOnly": true, "description": "Output only. The system-generated name of the provisioning config. This follows the UUID format.", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "DRAFT", "SUBMITTED", "PROVISIONING", "PROVISIONED", "VALIDATED", "CANCELLED", "FAILED" ], "description": "Output only. State of ProvisioningConfig.", "type": "string", "enumDescriptions": [ "State wasn't specified.", "ProvisioningConfig is a draft and can be freely modified.", "ProvisioningConfig was already submitted and cannot be modified.", "ProvisioningConfig was in the provisioning state. Initially this state comes from the work order table in big query when SNOW is used. Later this field can be set by the work order API.", "ProvisioningConfig was provisioned, meaning the resources exist.", "ProvisioningConfig was validated. A validation tool will be run to set this state.", "ProvisioningConfig was canceled.", "The request is submitted for provisioning, with error return." ], "readOnly": true }, "ticketId": { "description": "A generated ticket id to track provisioning request.", "type": "string" }, "location": { "description": "Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.", "type": "string" }, "volumes": { "description": "Volumes to be created.", "type": "array", "items": { "$ref": "VolumeConfig" } }, "email": { "deprecated": true, "description": "Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.", "type": "string" }, "pod": { "description": "Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.", "type": "string" }, "handoverServiceAccount": { "description": "A service account to enable customers to access instance credentials upon handover.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Last update timestamp.", "type": "string", "format": "google-datetime" }, "vpcScEnabled": { "description": "If true, VPC SC is enabled for the cluster.", "type": "boolean" } }, "id": "ProvisioningConfig", "description": "A provisioning configuration.", "type": "object" }, "NetworkConfig": { "description": "Configuration parameters for a new network.", "type": "object", "id": "NetworkConfig", "properties": { "jumboFramesEnabled": { "description": "The JumboFramesEnabled option for customer to set.", "type": "boolean" }, "type": { "enumDescriptions": [ "Unspecified value.", "Client network, that is a network peered to a GCP VPC.", "Private network, that is a network local to the BMS POD." ], "enum": [ "TYPE_UNSPECIFIED", "CLIENT", "PRIVATE" ], "description": "The type of this network, either Client or Private.", "type": "string" }, "bandwidth": { "description": "Interconnect bandwidth. Set only when type is CLIENT.", "type": "string", "enum": [ "BANDWIDTH_UNSPECIFIED", "BW_1_GBPS", "BW_2_GBPS", "BW_5_GBPS", "BW_10_GBPS" ], "enumDescriptions": [ "Unspecified value.", "1 Gbps.", "2 Gbps.", "5 Gbps.", "10 Gbps." ] }, "vrf": { "description": "Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.", "type": "string" }, "id": { "description": "A transient unique identifier to identify a volume within an ProvisioningConfig request.", "type": "string" }, "cidr": { "description": "CIDR range of the network.", "type": "string" }, "vlanAttachments": { "description": "List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf", "type": "array", "items": { "$ref": "IntakeVlanAttachment" } }, "userNote": { "description": "User note field, it can be used by customers to add additional information for the BMS Ops team .", "type": "string" }, "name": { "readOnly": true, "description": "Output only. The name of the network config.", "type": "string" }, "serviceCidr": { "description": "Service CIDR, if any.", "type": "string", "enum": [ "SERVICE_CIDR_UNSPECIFIED", "DISABLED", "HIGH_26", "HIGH_27", "HIGH_28" ], "enumDescriptions": [ "Unspecified value.", "Services are disabled for the given network.", "Use the highest /26 block of the network to host services.", "Use the highest /27 block of the network to host services.", "Use the highest /28 block of the network to host services." ] }, "vlanSameProject": { "description": "Whether the VLAN attachment pair is located in the same project.", "type": "boolean" }, "gcpService": { "description": "The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.", "type": "string" } } }, "StopInstanceResponse": { "description": "Response message from stopping a server.", "type": "object", "properties": {}, "id": "StopInstanceResponse" }, "LoadInstanceAuthInfoResponse": { "properties": { "userAccounts": { "description": "Map of username to the user account info.", "type": "object", "additionalProperties": { "$ref": "UserAccount" } }, "sshKeys": { "description": "List of ssh keys.", "type": "array", "items": { "$ref": "SSHKey" } } }, "id": "LoadInstanceAuthInfoResponse", "description": "Response for LoadInstanceAuthInfo.", "type": "object" }, "ResizeVolumeRequest": { "properties": { "sizeGib": { "description": "New Volume size, in GiB.", "type": "string", "format": "int64" } }, "id": "ResizeVolumeRequest", "description": "Request for emergency resize Volume.", "type": "object" }, "LunRange": { "description": "A LUN(Logical Unit Number) range.", "type": "object", "properties": { "quantity": { "description": "Number of LUNs to create.", "type": "integer", "format": "int32" }, "sizeGb": { "description": "The requested size of each LUN, in GB.", "type": "integer", "format": "int32" } }, "id": "LunRange" }, "DisableInteractiveSerialConsoleRequest": { "id": "DisableInteractiveSerialConsoleRequest", "properties": {}, "description": "Message for disabling the interactive serial console on an instance.", "type": "object" }, "VlanAttachment": { "description": "VLAN attachment details.", "type": "object", "id": "VlanAttachment", "properties": { "qosPolicy": { "description": "The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.", "$ref": "QosPolicy" }, "routerIp": { "description": "The router IP of the attachment.", "type": "string" }, "peerVlanId": { "description": "The peer vlan ID of the attachment.", "type": "string", "format": "int64" }, "pairingKey": { "description": "Input only. Pairing key.", "type": "string" }, "id": { "description": "Immutable. The identifier of the attachment within vrf.", "type": "string" }, "peerIp": { "description": "The peer IP of the attachment.", "type": "string" }, "interconnectAttachment": { "description": "Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}", "type": "string" } } }, "RenameInstanceRequest": { "description": "Message requesting rename of a server.", "type": "object", "properties": { "newInstanceId": { "description": "Required. The new `id` of the instance.", "type": "string" } }, "id": "RenameInstanceRequest" }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {}, "id": "Empty" }, "ListVolumesResponse": { "description": "Response message containing the list of storage volumes.", "type": "object", "id": "ListVolumesResponse", "properties": { "volumes": { "description": "The list of storage volumes.", "type": "array", "items": { "$ref": "Volume" } }, "nextPageToken": { "description": "A token identifying a page of results from the server.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "ProvisioningQuota": { "description": "A provisioning quota for a given project.", "type": "object", "properties": { "instanceQuota": { "description": "Instance quota.", "$ref": "InstanceQuota" }, "assetType": { "enumDescriptions": [ "The unspecified type.", "The server asset type.", "The storage asset type.", "The network asset type." ], "description": "The asset type of this provisioning quota.", "type": "string", "enum": [ "ASSET_TYPE_UNSPECIFIED", "ASSET_TYPE_SERVER", "ASSET_TYPE_STORAGE", "ASSET_TYPE_NETWORK" ] }, "gcpService": { "description": "The gcp service of the provisioning quota.", "type": "string" }, "networkBandwidth": { "description": "Network bandwidth, Gbps", "type": "string", "format": "int64" }, "availableCount": { "description": "The available count of the provisioning quota.", "type": "integer", "format": "int32" }, "storageGib": { "description": "Storage size (GB).", "type": "string", "format": "int64" }, "name": { "readOnly": true, "description": "Output only. The name of the provisioning quota.", "type": "string" }, "location": { "description": "The specific location of the provisioining quota.", "type": "string" }, "serverCount": { "description": "Server count.", "type": "string", "format": "int64" } }, "id": "ProvisioningQuota" }, "VRF": { "id": "VRF", "properties": { "name": { "description": "The name of the VRF.", "type": "string" }, "state": { "enumDescriptions": [ "The unspecified state.", "The vrf is provisioning.", "The vrf is provisioned." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "PROVISIONED" ], "description": "The possible state of VRF.", "type": "string" }, "qosPolicy": { "description": "The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.", "$ref": "QosPolicy" }, "vlanAttachments": { "description": "The list of VLAN attachments for the VRF.", "type": "array", "items": { "$ref": "VlanAttachment" } } }, "description": "A network VRF.", "type": "object" }, "QosPolicy": { "id": "QosPolicy", "properties": { "bandwidthGbps": { "description": "The bandwidth permitted by the QOS policy, in gbps.", "type": "number", "format": "double" } }, "description": "QOS policy parameters.", "type": "object" }, "ResetInstanceRequest": { "properties": {}, "id": "ResetInstanceRequest", "description": "Message requesting to reset a server.", "type": "object" }, "ListNfsSharesResponse": { "description": "Response message containing the list of NFS shares.", "type": "object", "properties": { "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results from the server.", "type": "string" }, "nfsShares": { "description": "The list of NFS shares.", "type": "array", "items": { "$ref": "NfsShare" } } }, "id": "ListNfsSharesResponse" }, "ListProvisioningQuotasResponse": { "description": "Response message for the list of provisioning quotas.", "type": "object", "properties": { "provisioningQuotas": { "description": "The provisioning quotas registered in this project.", "type": "array", "items": { "$ref": "ProvisioningQuota" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "id": "ListProvisioningQuotasResponse" }, "DisableInteractiveSerialConsoleResponse": { "id": "DisableInteractiveSerialConsoleResponse", "properties": {}, "description": "Message for response of DisableInteractiveSerialConsole.", "type": "object" }, "InstanceConfig": { "description": "Configuration parameters for a new instance.", "type": "object", "id": "InstanceConfig", "properties": { "networkConfig": { "enum": [ "NETWORKCONFIG_UNSPECIFIED", "SINGLE_VLAN", "MULTI_VLAN" ], "description": "The type of network configuration on the instance.", "type": "string", "enumDescriptions": [ "The unspecified network configuration.", "Instance part of single client network and single private network.", "Instance part of multiple (or single) client networks and private networks." ] }, "privateNetwork": { "description": "Private network address, if any. Filled if InstanceConfig.multivlan_config is false.", "$ref": "NetworkAddress", "deprecated": true }, "osImage": { "description": "OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)", "type": "string" }, "userNote": { "description": "User note field, it can be used by customers to add additional information for the BMS Ops team .", "type": "string" }, "networkTemplate": { "description": "Server network template name. Filled if InstanceConfig.multivlan_config is true.", "type": "string" }, "logicalInterfaces": { "description": "List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.", "type": "array", "items": { "$ref": "GoogleCloudBaremetalsolutionV2LogicalInterface" } }, "accountNetworksEnabled": { "description": "If true networks can be from different projects of the same vendor account.", "type": "boolean" }, "kmsKeyVersion": { "description": "Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.", "type": "string" }, "sshKeyNames": { "description": "Optional. List of names of ssh keys used to provision the instance.", "type": "array", "items": { "type": "string" } }, "clientNetwork": { "deprecated": true, "description": "Client network address. Filled if InstanceConfig.multivlan_config is false.", "$ref": "NetworkAddress" }, "name": { "description": "The name of the instance config.", "type": "string" }, "instanceType": { "description": "Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)", "type": "string" }, "id": { "deprecated": true, "description": "A transient unique identifier to identify an instance within an ProvisioningConfig request.", "type": "string" }, "hyperthreading": { "description": "Whether the instance should be provisioned with Hyperthreading enabled.", "type": "boolean" } } } }, "name": "baremetalsolution", "id": "baremetalsolution:v2", "mtlsRootUrl": "https://baremetalsolution.mtls.googleapis.com/", "rootUrl": "https://baremetalsolution.googleapis.com/", "revision": "20260319", "documentationLink": "https://cloud.google.com/bare-metal", "ownerName": "Google", "fullyEncodeReservedExpansion": true, "title": "Bare Metal Solution API", "servicePath": "", "basePath": "", "version": "v2", "version_module": true }