ProjectsLocationsInstances
class ProjectsLocationsInstances extends Resource (View source)
The "instances" collection of methods.
Typical usage is:
$notebooksService = new Google\Service\AIPlatformNotebooks(...);
$instances = $notebooksService->projects_locations_instances;Methods
Checks whether a notebook instance is upgradable.
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Gets details of a single Instance. (instances.get)
Gets general backend configurations that might also affect the frontend.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (instances.getIamPolicy)
Lists instances in a given project and location.
Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
Resets a notebook instance. (instances.reset)
Resize a notebook instance disk to a higher capacity. (instances.resizeDisk)
Rollbacks a notebook instance to the previous version. (instances.rollback)
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (instances.setIamPolicy)
Starts a notebook instance. (instances.start)
Stops a notebook instance. (instances.stop)
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
Upgrades a notebook instance to the latest version. (instances.upgrade)
Allows notebook instances to upgrade themselves. Do not use this method directly. (instances.upgradeSystem)
Details
CheckInstanceUpgradabilityResponse
checkUpgradability(string $notebookInstance, array $optParams = [])
Checks whether a notebook instance is upgradable.
(instances.checkUpgradability)
Operation
create(string $parent, Instance $postBody, array $optParams = [])
Creates a new Instance in a given project and location. (instances.create)
Operation
delete(string $name, array $optParams = [])
Deletes a single Instance. (instances.delete)
Operation
diagnose(string $name, DiagnoseInstanceRequest $postBody, array $optParams = [])
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
(instances.diagnose)
Instance
get(string $name, array $optParams = [])
Gets details of a single Instance. (instances.get)
Config
getConfig(string $name, array $optParams = [])
Gets general backend configurations that might also affect the frontend.
Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query. (instances.getConfig)
Policy
getIamPolicy(string $resource, array $optParams = [])
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (instances.getIamPolicy)
ListInstancesResponse
listProjectsLocationsInstances(string $parent, array $optParams = [])
Lists instances in a given project and location.
(instances.listProjectsLocationsInstances)
Operation
patch(string $name, Instance $postBody, array $optParams = [])
UpdateInstance updates an Instance. (instances.patch)
Operation
reportInfoSystem(string $name, ReportInstanceInfoSystemRequest $postBody, array $optParams = [])
Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
(instances.reportInfoSystem)
Operation
reset(string $name, ResetInstanceRequest $postBody, array $optParams = [])
Resets a notebook instance. (instances.reset)
Operation
resizeDisk(string $notebookInstance, ResizeDiskRequest $postBody, array $optParams = [])
Resize a notebook instance disk to a higher capacity. (instances.resizeDisk)
Operation
rollback(string $name, RollbackInstanceRequest $postBody, array $optParams = [])
Rollbacks a notebook instance to the previous version. (instances.rollback)
Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (instances.setIamPolicy)
Operation
start(string $name, StartInstanceRequest $postBody, array $optParams = [])
Starts a notebook instance. (instances.start)
Operation
stop(string $name, StopInstanceRequest $postBody, array $optParams = [])
Stops a notebook instance. (instances.stop)
TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
This operation may "fail open" without warning. (instances.testIamPermissions)
Operation
upgrade(string $name, UpgradeInstanceRequest $postBody, array $optParams = [])
Upgrades a notebook instance to the latest version. (instances.upgrade)
Operation
upgradeSystem(string $name, UpgradeInstanceSystemRequest $postBody, array $optParams = [])
Allows notebook instances to upgrade themselves. Do not use this method directly. (instances.upgradeSystem)