InstancesResource class

Constructors

InstancesResource(ApiRequester client)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addAccessConfig(AccessConfig request, String project, String zone, String instance, String networkInterface, {String? requestId, String? $fields}) → Future<Operation>
Adds an access config to an instance's network interface.
addNetworkInterface(NetworkInterface request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Adds one dynamic network interface to an active instance.
addResourcePolicies(InstancesAddResourcePoliciesRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Adds existing resource policies to an instance.
aggregatedList(String project, {String? filter, bool? includeAllScopes, int? maxResults, String? orderBy, String? pageToken, bool? returnPartialSuccess, String? serviceProjectNumber, String? $fields}) → Future<InstanceAggregatedList>
Retrieves an aggregated list of all of the instances in your project across all regions and zones.
attachDisk(AttachedDisk request, String project, String zone, String instance, {bool? forceAttach, String? requestId, String? $fields}) → Future<Operation>
Attaches an existing Disk resource to an instance.
bulkInsert(BulkInsertInstanceResource request, String project, String zone, {String? requestId, String? $fields}) → Future<Operation>
Creates multiple instances.
delete(String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Deletes the specified Instance resource.
deleteAccessConfig(String project, String zone, String instance, String accessConfig, String networkInterface, {String? requestId, String? $fields}) → Future<Operation>
Deletes an access config from an instance's network interface.
deleteNetworkInterface(String project, String zone, String instance, String networkInterfaceName, {String? requestId, String? $fields}) → Future<Operation>
Deletes one dynamic network interface from an active instance.
detachDisk(String project, String zone, String instance, String deviceName, {String? requestId, String? $fields}) → Future<Operation>
Detaches a disk from an instance.
get(String project, String zone, String instance, {String? $fields}) → Future<Instance>
Returns the specified Instance resource.
getEffectiveFirewalls(String project, String zone, String instance, String networkInterface, {String? $fields}) → Future<InstancesGetEffectiveFirewallsResponse>
Returns effective firewalls applied to an interface of the instance.
getGuestAttributes(String project, String zone, String instance, {String? queryPath, String? variableKey, String? $fields}) → Future<GuestAttributes>
Returns the specified guest attributes entry.
getIamPolicy(String project, String zone, String resource, {int? optionsRequestedPolicyVersion, String? $fields}) → Future<Policy>
Gets the access control policy for a resource.
getScreenshot(String project, String zone, String instance, {String? $fields}) → Future<Screenshot>
Returns the screenshot from the specified instance.
getSerialPortOutput(String project, String zone, String instance, {int? port, String? start_1, String? $fields}) → Future<SerialPortOutput>
Returns the last 1 MB of serial port output from the specified instance.
getShieldedInstanceIdentity(String project, String zone, String instance, {String? $fields}) → Future<ShieldedInstanceIdentity>
Returns the Shielded Instance Identity of an instance
insert(Instance request, String project, String zone, {String? requestId, String? sourceInstanceTemplate, String? sourceMachineImage, String? $fields}) → Future<Operation>
Creates an instance resource in the specified project using the data included in the request.
list(String project, String zone, {String? filter, int? maxResults, String? orderBy, String? pageToken, bool? returnPartialSuccess, String? $fields}) → Future<InstanceList>
Retrieves the list of instances contained within the specified zone.
listReferrers(String project, String zone, String instance, {String? filter, int? maxResults, String? orderBy, String? pageToken, bool? returnPartialSuccess, String? $fields}) → Future<InstanceListReferrers>
Retrieves a list of resources that refer to the VM instance specified in the request.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
performMaintenance(String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Perform a manual maintenance on the instance.
removeResourcePolicies(InstancesRemoveResourcePoliciesRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Removes resource policies from an instance.
reportHostAsFaulty(InstancesReportHostAsFaultyRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Mark the host as faulty and try to restart the instance on a new host.
reset(String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Performs a reset on the instance.
resume(String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Resumes an instance that was suspended using the instances().suspend method.
sendDiagnosticInterrupt(String project, String zone, String instance, {String? $fields}) → Future<void>
Sends diagnostic interrupt to the instance.
setDeletionProtection(String project, String zone, String resource, {bool? deletionProtection, String? requestId, String? $fields}) → Future<Operation>
Sets deletion protection on the instance.
setDiskAutoDelete(String project, String zone, String instance, bool autoDelete, String deviceName, {String? requestId, String? $fields}) → Future<Operation>
Sets the auto-delete flag for a disk attached to an instance.
setIamPolicy(ZoneSetPolicyRequest request, String project, String zone, String resource, {String? $fields}) → Future<Policy>
Sets the access control policy on the specified resource.
setLabels(InstancesSetLabelsRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets labels on an instance.
setMachineResources(InstancesSetMachineResourcesRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
setMachineType(InstancesSetMachineTypeRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Changes the machine type for a stopped instance to the machine type specified in the request.
setMetadata(Metadata request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets metadata for the specified instance to the data included in the request.
setMinCpuPlatform(InstancesSetMinCpuPlatformRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Changes the minimum CPU platform that this instance should use.
setName(InstancesSetNameRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets name of an instance.
setScheduling(Scheduling request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets an instance's scheduling options.
setSecurityPolicy(InstancesSetSecurityPolicyRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets the Google Cloud Armor security policy for the specified instance.
setServiceAccount(InstancesSetServiceAccountRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets the service account on the instance.
setShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets the Shielded Instance integrity policy for an instance.
setTags(Tags request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Sets network tags for the specified instance to the data included in the request.
simulateMaintenanceEvent(String project, String zone, String instance, {String? requestId, bool? withExtendedNotifications, String? $fields}) → Future<Operation>
Simulates a host maintenance event on a VM.
start(String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Starts an instance that was stopped using the instances().stop method.
startWithEncryptionKey(InstancesStartWithEncryptionKeyRequest request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Starts an instance that was stopped using the instances().stop method.
stop(String project, String zone, String instance, {bool? discardLocalSsd, String? requestId, String? $fields}) → Future<Operation>
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time.
suspend(String project, String zone, String instance, {bool? discardLocalSsd, String? requestId, String? $fields}) → Future<Operation>
This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time.
testIamPermissions(TestPermissionsRequest request, String project, String zone, String resource, {String? $fields}) → Future<TestPermissionsResponse>
Returns permissions that a caller has on the specified resource.
toString() → String
A string representation of this object.
inherited
update(Instance request, String project, String zone, String instance, {String? minimalAction, String? mostDisruptiveAllowedAction, String? requestId, String? $fields}) → Future<Operation>
Updates an instance only if the necessary resources are available.
updateAccessConfig(AccessConfig request, String project, String zone, String instance, String networkInterface, {String? requestId, String? $fields}) → Future<Operation>
Updates the specified access config from an instance's network interface with the data included in the request.
updateDisplayDevice(DisplayDevice request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Updates the Display config for a VM instance.
updateNetworkInterface(NetworkInterface request, String project, String zone, String instance, String networkInterface, {String? requestId, String? $fields}) → Future<Operation>
Updates an instance's network interface.
updateShieldedInstanceConfig(ShieldedInstanceConfig request, String project, String zone, String instance, {String? requestId, String? $fields}) → Future<Operation>
Updates the Shielded Instance config for an instance.

Operators

operator ==(Object other) → bool
The equality operator.
inherited