1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Baremetalsolution
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsInstances

ProjectsLocationsInstances

class ProjectsLocationsInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $baremetalsolutionService = new Google\Service\Baremetalsolution(...);
 $instances = $baremetalsolutionService->projects_locations_instances;

Methods

Operation
detachLun(string $instance, DetachLunRequest $postBody, array $optParams = [])

Detach LUN from Instance. (instances.detachLun)

Operation
disableHyperthreading(string $name, DisableHyperthreadingRequest $postBody, array $optParams = [])

Perform disable hyperthreading operation on a single server.

Operation
disableInteractiveSerialConsole(string $name, DisableInteractiveSerialConsoleRequest $postBody, array $optParams = [])

Disable the interactive serial console feature on an instance.

Operation
enableHyperthreading(string $name, EnableHyperthreadingRequest $postBody, array $optParams = [])

Perform enable hyperthreading operation on a single server.

Operation
enableInteractiveSerialConsole(string $name, EnableInteractiveSerialConsoleRequest $postBody, array $optParams = [])

Enable the interactive serial console feature on an instance.

Instance
get(string $name, array $optParams = [])

Get details about a single server. (instances.get)

ListInstancesResponse
listProjectsLocationsInstances(string $parent, array $optParams = [])

List servers in a given project and location.

LoadInstanceAuthInfoResponse
loadAuthInfo(string $name, array $optParams = [])

Load auth info for a server. (instances.loadAuthInfo)

Operation
patch(string $name, Instance $postBody, array $optParams = [])

Update details of a single server. (instances.patch)

Operation
reimage(string $name, ReimageInstanceRequest $postBody, array $optParams = [])

Perform reimage operation on a single server. (instances.reimage)

Instance
rename(string $name, RenameInstanceRequest $postBody, array $optParams = [])

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

Operation
reset(string $name, ResetInstanceRequest $postBody, array $optParams = [])

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

Operation
start(string $name, StartInstanceRequest $postBody, array $optParams = [])

Starts a server that was shutdown. (instances.start)

Operation
stop(string $name, StopInstanceRequest $postBody, array $optParams = [])

Stop a running server. (instances.stop)

Details

at line 54
Operation detachLun(string $instance, DetachLunRequest $postBody, array $optParams = [])

Detach LUN from Instance. (instances.detachLun)

Parameters

string $instance

Required. Name of the instance.
DetachLunRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 72
Operation disableHyperthreading(string $name, DisableHyperthreadingRequest $postBody, array $optParams = [])

Perform disable hyperthreading operation on a single server.

(instances.disableHyperthreading)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 88
Operation disableInteractiveSerialConsole(string $name, DisableInteractiveSerialConsoleRequest $postBody, array $optParams = [])

Disable the interactive serial console feature on an instance.

(instances.disableInteractiveSerialConsole)

Parameters

string $name

Required. Name of the resource.
DisableInteractiveSerialConsoleRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 106
Operation enableHyperthreading(string $name, EnableHyperthreadingRequest $postBody, array $optParams = [])

Perform enable hyperthreading operation on a single server.

(instances.enableHyperthreading)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 122
Operation enableInteractiveSerialConsole(string $name, EnableInteractiveSerialConsoleRequest $postBody, array $optParams = [])

Enable the interactive serial console feature on an instance.

(instances.enableInteractiveSerialConsole)

Parameters

string $name

Required. Name of the resource.
EnableInteractiveSerialConsoleRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 136
Instance get(string $name, array $optParams = [])

Get details about a single server. (instances.get)

Parameters

string $name

Required. Name of the resource.
array $optParams

Optional parameters.

Return Value

Instance

Exceptions

Exception

at line 157
ListInstancesResponse listProjectsLocationsInstances(string $parent, array $optParams = [])

List servers in a given project and location.

(instances.listProjectsLocationsInstances)

Parameters

string $parent

Required. Parent value for ListInstancesRequest.
array $optParams

Optional parameters.

Return Value

ListInstancesResponse

Exceptions

Exception

at line 171
LoadInstanceAuthInfoResponse loadAuthInfo(string $name, array $optParams = [])

Load auth info for a server. (instances.loadAuthInfo)

Parameters

string $name

Required. Name of the server.
array $optParams

Optional parameters.

Return Value

LoadInstanceAuthInfoResponse

Exceptions

Exception

at line 193
Operation patch(string $name, Instance $postBody, array $optParams = [])

Update details of a single server. (instances.patch)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 210
Operation reimage(string $name, ReimageInstanceRequest $postBody, array $optParams = [])

Perform reimage operation on a single server. (instances.reimage)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 228
Instance rename(string $name, RenameInstanceRequest $postBody, array $optParams = [])

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

Parameters

string $name

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

Optional parameters.

Return Value

Instance

Exceptions

Exception

at line 244
Operation reset(string $name, ResetInstanceRequest $postBody, array $optParams = [])

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

Parameters

string $name

Required. Name of the resource.
ResetInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 259
Operation start(string $name, StartInstanceRequest $postBody, array $optParams = [])

Starts a server that was shutdown. (instances.start)

Parameters

string $name

Required. Name of the resource.
StartInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 274
Operation stop(string $name, StopInstanceRequest $postBody, array $optParams = [])

Stop a running server. (instances.stop)

Parameters

string $name

Required. Name of the resource.
StopInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception