Compute Engine API Connector Overview Stay organized with collections Save and categorize content based on your preferences.
The Workflows connector defines the built-infunctions that can be used to access other Google Cloud products within aworkflow.
This page provides an overview of the individual connector.There is no need to import or load connector libraries in a workflow—connectorswork out of the box when used in a call step.
Compute Engine API
Creates and runs virtual machines on Google Cloud Platform. To learn more, see theCompute Engine API documentation.
Compute Engine connector sample
YAML
# This workflow demonstrates how to use the Compute Engine connector:# Create and start a Compute Engine VM instance, then stop and delete the VM# Each step waits until the long-running operation of stopping or starting the VM completes# After each step, the machine status is verified# Expected output: "SUCCESS"main:params:[]steps:-init:assign:-project:${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}-zone:"us-central1-a"-instance:"INSTANCE_NAME"# replace INSTANCE_NAME placeholder-machineType:"e2-micro"-insert_machine:call:googleapis.compute.v1.instances.insertargs:project:${project}zone:${zone}body:name:${instance}machineType:${"zones/" + zone + "/machineTypes/" + machineType}disks:-initializeParams:sourceImage:"projects/debian-cloud/global/images/debian-10-buster-v20201112"boot:trueautoDelete:truenetworkInterfaces:-network:"global/networks/default"-start_machine:call:googleapis.compute.v1.instances.startargs:instance:${instance}project:${project}zone:${zone}-assert_running:call:assert_machine_statusargs:expected_status:"RUNNING"project:${project}zone:${zone}instance:${instance}-stop_machine:call:googleapis.compute.v1.instances.stopargs:instance:${instance}project:${project}zone:${zone}-assert_terminated:call:assert_machine_statusargs:expected_status:"TERMINATED"project:${project}zone:${zone}instance:${instance}-delete_machine:call:googleapis.compute.v1.instances.deleteargs:instance:${instance}project:${project}zone:${zone}-the_end:return:"SUCCESS"assert_machine_status:params:[expected_status,project,zone,instance]steps:-get_instance:call:googleapis.compute.v1.instances.getargs:instance:${instance}project:${project}zone:${zone}result:instance-compare:switch:-condition:${instance.status == expected_status}next:end-fail:raise:${"Expected VM status is " + expected_status + ". Received " + instance.status + " instead."}JSON
{"main":{"params":[],"steps":[{"init":{"assign":[{"project":"${sys.get_env(\"GOOGLE_CLOUD_PROJECT_ID\")}"},{"zone":"us-central1-a"},{"instance":"INSTANCE_NAME"},{"machineType":"e2-micro"}]}},{"insert_machine":{"call":"googleapis.compute.v1.instances.insert","args":{"project":"${project}","zone":"${zone}","body":{"name":"${instance}","machineType":"${\"zones/\" + zone + \"/machineTypes/\" + machineType}","disks":[{"initializeParams":{"sourceImage":"projects/debian-cloud/global/images/debian-10-buster-v20201112"},"boot":true,"autoDelete":true}],"networkInterfaces":[{"network":"global/networks/default"}]}}}},{"start_machine":{"call":"googleapis.compute.v1.instances.start","args":{"instance":"${instance}","project":"${project}","zone":"${zone}"}}},{"assert_running":{"call":"assert_machine_status","args":{"expected_status":"RUNNING","project":"${project}","zone":"${zone}","instance":"${instance}"}}},{"stop_machine":{"call":"googleapis.compute.v1.instances.stop","args":{"instance":"${instance}","project":"${project}","zone":"${zone}"}}},{"assert_terminated":{"call":"assert_machine_status","args":{"expected_status":"TERMINATED","project":"${project}","zone":"${zone}","instance":"${instance}"}}},{"delete_machine":{"call":"googleapis.compute.v1.instances.delete","args":{"instance":"${instance}","project":"${project}","zone":"${zone}"}}},{"the_end":{"return":"SUCCESS"}}]},"assert_machine_status":{"params":["expected_status","project","zone","instance"],"steps":[{"get_instance":{"call":"googleapis.compute.v1.instances.get","args":{"instance":"${instance}","project":"${project}","zone":"${zone}"},"result":"instance"}},{"compare":{"switch":[{"condition":"${instance.status == expected_status}","next":"end"}]}},{"fail":{"raise":"${\"Expected VM status is \" + expected_status + \". Received \" + instance.status + \" instead.\"}"}}]}}Module: googleapis.compute.beta.acceleratorTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of accelerator types. |
get | Returns the specified accelerator type. |
list | Retrieves a list of accelerator types that are available to thespecified project. |
Module: googleapis.compute.beta.addresses
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of addresses. |
delete | Deletes the specified address resource. |
get | Returns the specified address resource. |
insert | Creates an address resource in the specified project by using the dataincluded in the request. |
list | Retrieves a list of addresses contained within the specified region. |
move | Moves the specified address resource. |
setLabels | Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.autoscalers
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of autoscalers. |
delete | Deletes the specified autoscaler. |
get | Returns the specified autoscaler resource. |
insert | Creates an autoscaler in the specified project using the data includedin the request. |
list | Retrieves a list of autoscalers contained within the specified zone. |
patch | Updates an autoscaler in the specified project using the data includedin the request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates an autoscaler in the specified project using the data includedin the request. |
Module: googleapis.compute.beta.backendBuckets
| Functions | |
|---|---|
addSignedUrlKey | Adds a key for validating requests with signed URLs for this backendbucket. |
delete | Deletes the specified BackendBucket resource. |
deleteSignedUrlKey | Deletes a key for validating requests with signed URLs for this backendbucket. |
get | Returns the specified BackendBucket resource. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a BackendBucket resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of BackendBucket resources available to the specifiedproject. |
patch | Updates the specified BackendBucket resource with the data included inthe request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
setEdgeSecurityPolicy | Sets the edge security policy for the specified backend bucket. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified BackendBucket resource with the data included inthe request. |
Module: googleapis.compute.beta.backendServices
| Functions | |
|---|---|
addSignedUrlKey | Adds a key for validating requests with signed URLs for this backendservice. |
aggregatedList | Retrieves the list of all BackendService resources, regional and global,available to the specified project. |
delete | Deletes the specified BackendService resource. |
deleteSignedUrlKey | Deletes a key for validating requests with signed URLs for this backendservice. |
get | Returns the specified BackendService resource. |
getHealth | Gets the most recent health check results for this BackendService.Example request body: { "group":"/zones/us-east1-b/instanceGroups/lb-backend-example" } |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a BackendService resource in the specified project using thedata included in the request. For more information, see Backend servicesoverview . |
list | Retrieves the list of BackendService resources available to thespecified project. |
patch | Patches the specified BackendService resource with the data included inthe request. For more information, see Backend services overview. Thismethod supports PATCH semantics and uses the JSON merge patch format andprocessing rules. |
setEdgeSecurityPolicy | Sets the edge security policy for the specified backend service. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setSecurityPolicy | Sets the Google Cloud Armor security policy for the specified backendservice. For more information, see Google Cloud Armor Overview |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified BackendService resource with the data included inthe request. For more information, see Backend services overview. |
Module: googleapis.compute.beta.diskTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of disk types. |
get | Returns the specified disk type. |
list | Retrieves a list of disk types available to the specified project. |
Module: googleapis.compute.beta.disks
| Functions | |
|---|---|
addResourcePolicies | Adds existing resource policies to a disk. You can only add one policywhich will be applied to this disk for scheduling snapshot creation. |
aggregatedList | Retrieves an aggregated list of persistent disks. |
bulkInsert | Bulk create a set of disks. |
createSnapshot | Creates a snapshot of a specified persistent disk. For regular snapshotcreation, consider using snapshots.insert instead, as that methodsupports more features, such as creating snapshots in a projectdifferent from the source disk project. |
delete | Deletes the specified persistent disk. Deleting a disk removes its datapermanently and is irreversible. However, deleting a disk does notdelete any snapshots previously made from the disk. You must separatelydelete snapshots. |
get | Returns the specified persistent disk. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a persistent disk in the specified project using the data in therequest. You can create a disk from a source (sourceImage,sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk byomitting all properties. You can also create a disk that is larger thanthe default size by specifying the sizeGb property. |
list | Retrieves a list of persistent disks contained within the specifiedzone. |
removeResourcePolicies | Removes resource policies from a disk. |
resize | Resizes the specified persistent disk. You can only increase the size ofthe disk. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on a disk. To learn more about labels, read the LabelingResources documentation. |
startAsyncReplication | Starts asynchronous replication. Must be invoked on the primary disk. |
stopAsyncReplication | Stops asynchronous replication. Can be invoked either on the primary oron the secondary disk. |
stopGroupAsyncReplication | Stops asynchronous replication for a consistency group of disks. Can beinvoked either in the primary or secondary scope. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified disk with the data included in the request. Theupdate is performed only on selected fields included as part ofupdate-mask. Only the following fields can be modified: user_license. |
Module: googleapis.compute.beta.externalVpnGateways
| Functions | |
|---|---|
delete | Deletes the specified externalVpnGateway. |
get | Returns the specified externalVpnGateway. Get a list of availableexternalVpnGateways by making a list() request. |
insert | Creates a ExternalVpnGateway in the specified project using the dataincluded in the request. |
list | Retrieves the list of ExternalVpnGateway available to the specifiedproject. |
setLabels | Sets the labels on an ExternalVpnGateway. To learn more about labels,read the Labeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.firewallPolicies
| Functions | |
|---|---|
addAssociation | Inserts an association for the specified firewall policy. |
addRule | Inserts a rule into a firewall policy. |
cloneRules | Copies rules to the specified firewall policy. |
delete | Deletes the specified policy. |
get | Returns the specified firewall policy. |
getAssociation | Gets an association with the specified name. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getRule | Gets a rule of the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | Lists all the policies that have been configured for the specifiedfolder or organization. |
listAssociations | Lists associations of a specified target, i.e., organization or folder. |
move | Moves the specified firewall policy. |
patch | Patches the specified policy with the data included in the request. |
patchRule | Patches a rule of the specified priority. |
removeAssociation | Removes an association for the specified firewall policy. |
removeRule | Deletes a rule of the specified priority. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.firewalls
| Functions | |
|---|---|
delete | Deletes the specified firewall. |
get | Returns the specified firewall. |
insert | Creates a firewall rule in the specified project using the data includedin the request. |
list | Retrieves the list of firewall rules available to the specified project. |
patch | Updates the specified firewall rule with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified firewall rule with the data included in therequest. Note that all fields will be updated if using PUT, even fieldsthat are not specified. To update individual fields, please use PATCHinstead. |
Module: googleapis.compute.beta.forwardingRules
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of forwarding rules. |
delete | Deletes the specified ForwardingRule resource. |
get | Returns the specified ForwardingRule resource. |
insert | Creates a ForwardingRule resource in the specified project and regionusing the data included in the request. |
list | Retrieves a list of ForwardingRule resources available to the specifiedproject and region. |
patch | Updates the specified forwarding rule with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. Currently, you can only patch thenetwork_tier field. |
setLabels | Sets the labels on the specified resource. To learn more about labels,read the Labeling Resources documentation. |
setTarget | Changes target URL for forwarding rule. The new target should be of thesame type as the old target. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.globalAddresses
| Functions | |
|---|---|
delete | Deletes the specified address resource. |
get | Returns the specified address resource. |
insert | Creates an address resource in the specified project by using the dataincluded in the request. |
list | Retrieves a list of global addresses. |
move | Moves the specified address resource from one project to anotherproject. |
setLabels | Sets the labels on a GlobalAddress. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.globalForwardingRules
| Functions | |
|---|---|
delete | Deletes the specified GlobalForwardingRule resource. |
get | Returns the specified GlobalForwardingRule resource. Gets a list ofavailable forwarding rules by making a list() request. |
insert | Creates a GlobalForwardingRule resource in the specified project usingthe data included in the request. |
list | Retrieves a list of GlobalForwardingRule resources available to thespecified project. |
patch | Updates the specified forwarding rule with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. Currently, you can only patch thenetwork_tier field. |
setLabels | Sets the labels on the specified resource. To learn more about labels,read the Labeling resources documentation. |
setTarget | Changes target URL for the GlobalForwardingRule resource. The new targetshould be of the same type as the old target. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.globalNetworkEndpointGroups
| Functions | |
|---|---|
attachNetworkEndpoints | Attach a network endpoint to the specified network endpoint group. |
delete | Deletes the specified network endpoint group.Note that the NEG cannot bedeleted if there are backend services referencing it. |
detachNetworkEndpoints | Detach the network endpoint from the specified network endpoint group. |
get | Returns the specified network endpoint group. |
insert | Creates a network endpoint group in the specified project using theparameters that are included in the request. |
list | Retrieves the list of network endpoint groups that are located in thespecified project. |
listNetworkEndpoints | Lists the network endpoints in the specified network endpoint group. |
Module: googleapis.compute.beta.globalOperations
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of all operations. |
delete | Deletes the specified Operations resource. |
get | Retrieves the specified Operations resource. |
list | Retrieves a list of Operation resources contained within the specifiedproject. |
wait | Waits for the specified Operation resource to return asDONE or forthe request to approach the 2 minute deadline, and retrieves thespecified Operation resource. This method differs from theGET methodin that it waits for no more than the default deadline (2 minutes) andthen returns the current state of the operation, which might beDONEor still in progress. This method is called on a best-effort basis.Specifically: - In uncommon cases, when the server is overloaded, therequest might return before the default deadline is reached, or mightreturn after zero seconds. - If the default deadline is reached, thereis no guarantee that the operation is actually done when the methodreturns. Be prepared to retry if the operation is notDONE. |
Module: googleapis.compute.beta.globalOrganizationOperations
| Functions | |
|---|---|
delete | Deletes the specified Operations resource. |
get | Retrieves the specified Operations resource. Gets a list of operationsby making alist() request. |
list | Retrieves a list of Operation resources contained within the specifiedorganization. |
Module: googleapis.compute.beta.globalPublicDelegatedPrefixes
| Functions | |
|---|---|
delete | Deletes the specified global PublicDelegatedPrefix. |
get | Returns the specified global PublicDelegatedPrefix resource. |
insert | Creates a global PublicDelegatedPrefix in the specified project usingthe parameters that are included in the request. |
list | Lists the global PublicDelegatedPrefixes for a project. |
patch | Patches the specified global PublicDelegatedPrefix resource with thedata included in the request. This method supports PATCH semantics anduses JSON merge patch format and processing rules. |
Module: googleapis.compute.beta.healthChecks
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all HealthCheck resources, regional and global,available to the specified project. |
delete | Deletes the specified HealthCheck resource. |
get | Returns the specified HealthCheck resource. |
insert | Creates a HealthCheck resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of HealthCheck resources available to the specifiedproject. |
patch | Updates a HealthCheck resource in the specified project using the dataincluded in the request. This method supports PATCH semantics and usesthe JSON merge patch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates a HealthCheck resource in the specified project using the dataincluded in the request. |
Module: googleapis.compute.beta.httpHealthChecks
| Functions | |
|---|---|
delete | Deletes the specified HttpHealthCheck resource. |
get | Returns the specified HttpHealthCheck resource. |
insert | Creates a HttpHealthCheck resource in the specified project using thedata included in the request. |
list | Retrieves the list of HttpHealthCheck resources available to thespecified project. |
patch | Updates a HttpHealthCheck resource in the specified project using thedata included in the request. This method supports PATCH semantics anduses the JSON merge patch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates a HttpHealthCheck resource in the specified project using thedata included in the request. |
Module: googleapis.compute.beta.httpsHealthChecks
| Functions | |
|---|---|
delete | Deletes the specified HttpsHealthCheck resource. |
get | Returns the specified HttpsHealthCheck resource. |
insert | Creates a HttpsHealthCheck resource in the specified project using thedata included in the request. |
list | Retrieves the list of HttpsHealthCheck resources available to thespecified project. |
patch | Updates a HttpsHealthCheck resource in the specified project using thedata included in the request. This method supports PATCH semantics anduses the JSON merge patch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates a HttpsHealthCheck resource in the specified project using thedata included in the request. |
Module: googleapis.compute.beta.imageFamilyViews
| Functions | |
|---|---|
get | Returns the latest image that is part of an image family, is notdeprecated and is rolled out in the specified zone. |
Module: googleapis.compute.beta.images
| Functions | |
|---|---|
delete | Deletes the specified image. |
deprecate | Sets the deprecation status of an image. If an empty request body isgiven, clears the deprecation status instead. |
get | Returns the specified image. |
getFromFamily | Returns the latest image that is part of an image family and is notdeprecated. For more information on image families, see Public imagefamilies documentation. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates an image in the specified project using the data included in therequest. |
list | Retrieves the list of custom images available to the specified project.Custom images are images you create that belong to your project. Thismethod does not get any images that belong to other projects, includingpublicly-available images, like Debian 8. If you want to get a list ofpublicly-available images, use this method to make a request to therespective image project, such as debian-cloud or windows-cloud. |
patch | Patches the specified image with the data included in the request. Onlythe following fields can be modified: family, description, deprecationstatus. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on an image. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.instanceGroupManagers
| Functions | |
|---|---|
abandonInstances | Flags the specified instances to be removed from the managed instancegroup. Abandoning an instance does not delete the instance, but it doesremove the instance from any target pools that are applied by themanaged instance group. This method reduces the targetSize of themanaged instance group by the number of instances that you abandon. Thisoperation is marked as DONE when the action is scheduled even if theinstances have not yet been removed from the group. You must separatelyverify the status of the abandoning action with the listmanagedinstancesmethod. If the group is part of a backend service that has enabledconnection draining, it can take up to 60 seconds after the connectiondraining duration has elapsed before the VM instance is removed ordeleted. You can specify a maximum of 1000 instances with this methodper request. |
aggregatedList | Retrieves the list of managed instance groups and groups them by zone. |
applyUpdatesToInstances | Applies changes to selected instances on the managed instance group.This method can be used to apply new overrides and/or new versions. |
createInstances | Creates instances with per-instance configurations in this managedinstance group. Instances are created using the current instancetemplate. The create instances operation is marked DONE if thecreateInstances request is successful. The underlying actions takeadditional time. You must separately verify the status of the creatingor actions with the listmanagedinstances method. |
delete | Deletes the specified managed instance group and all of the instances inthat group. Note that the instance group must not belong to a backendservice. Read Deleting an instance group for more information. |
deleteInstances | Flags the specified instances in the managed instance group forimmediate deletion. The instances are also removed from any target poolsof which they were a member. This method reduces the targetSize of themanaged instance group by the number of instances that you delete. Thisoperation is marked as DONE when the action is scheduled even if theinstances are still being deleted. You must separately verify the statusof the deleting action with the listmanagedinstances method. If thegroup is part of a backend service that has enabled connection draining,it can take up to 60 seconds after the connection draining duration haselapsed before the VM instance is removed or deleted. You can specify amaximum of 1000 instances with this method per request. |
deletePerInstanceConfigs | Deletes selected per-instance configurations for the managed instancegroup. |
get | Returns all of the details about the specified managed instance group. |
insert | Creates a managed instance group using the information that you specifyin the request. After the group is created, instances in the group arecreated using the specified instance template. This operation is markedas DONE when the group is created even if the instances in the grouphave not yet been created. You must separately verify the status of theindividual instances with the listmanagedinstances method. A managedinstance group can have up to 1000 VM instances per group. Pleasecontact Cloud Support if you need an increase in this limit. |
list | Retrieves a list of managed instance groups that are contained withinthe specified project and zone. |
listErrors | Lists all errors thrown by actions on instances for a given managedinstance group. The filter and orderBy query parameters are notsupported. |
listManagedInstances | Lists all of the instances in the managed instance group. Each instancein the list has a currentAction, which indicates the action that themanaged instance group is performing on the instance. For example, ifthe group is still creating an instance, the currentAction is CREATING.If a previous action failed, the list displays the errors for thatfailed action. The orderBy query parameter is not supported. ThepageToken query parameter is supported only in the alpha and beta APIand only if the group'slistManagedInstancesResults field is set toPAGINATED. |
listPerInstanceConfigs | Lists all of the per-instance configurations defined for the managedinstance group. The orderBy query parameter is not supported. |
patch | Updates a managed instance group using the information that you specifyin the request. This operation is marked as DONE when the group ispatched even if the instances in the group are still in the process ofbeing patched. You must separately verify the status of the individualinstances with the listManagedInstances method. This method supportsPATCH semantics and uses the JSON merge patch format and processingrules. If you update your group to specify a new template or instanceconfiguration, it's possible that your intended specification for eachVM in the group is different from the current state of that VM. To learnhow to apply an updated configuration to the VMs in a MIG, see Updatinginstances in a MIG. |
patchPerInstanceConfigs | Inserts or patches per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
recreateInstances | Flags the specified VM instances in the managed instance group to beimmediately recreated. Each instance is recreated using the group'scurrent configuration. This operation is marked as DONE when the flag isset even if the instances have not yet been recreated. You mustseparately verify the status of each instance by checking itscurrentAction field; for more information, see Checking the status ofmanaged instances. If the group is part of a backend service that hasenabled connection draining, it can take up to 60 seconds after theconnection draining duration has elapsed before the VM instance isremoved or deleted. You can specify a maximum of 1000 instances withthis method per request. |
resize | Resizes the managed instance group. If you increase the size, the groupcreates new instances using the current instance template. If youdecrease the size, the group deletes instances. The resize operation ismarked DONE when the resize actions are scheduled even if the group hasnot yet added or deleted any instances. You must separately verify thestatus of the creating or deleting actions with the listmanagedinstancesmethod. When resizing down, the instance group arbitrarily chooses theorder in which VMs are deleted. The group takes into account some VMattributes when making the selection including: + The status of the VMinstance. + The health of the VM instance. + The instance templateversion the VM is based on. + For regional managed instance groups, thelocation of the VM instance. This list is subject to change. If thegroup is part of a backend service that has enabled connection draining,it can take up to 60 seconds after the connection draining duration haselapsed before the VM instance is removed or deleted. |
resizeAdvanced | Resizes the managed instance group with advanced configuration optionslike disabling creation retries. This is an extended version of theresize method. If you increase the size of the instance group, the groupcreates new instances using the current instance template. If youdecrease the size, the group deletes instances. The resize operation ismarked DONE when the resize actions are scheduled even if the group hasnot yet added or deleted any instances. You must separately verify thestatus of the creating, creatingWithoutRetries, or deleting actions withthe get or listmanagedinstances method. If the group is part of abackend service that has enabled connection draining, it can take up to60 seconds after the connection draining duration has elapsed before theVM instance is removed or deleted. |
setAutoHealingPolicies | Motifies the autohealing policy for the instances in this managedinstance group. [Deprecated] This method is deprecated. UseinstanceGroupManagers.patch instead. |
setInstanceTemplate | Specifies the instance template to use when creating new instances inthis group. The templates for existing instances in the group do notchange unless you run recreateInstances, run applyUpdatesToInstances, orset the group's updatePolicy.type to PROACTIVE. |
setTargetPools | Modifies the target pools to which all instances in this managedinstance group are assigned. The target pools automatically apply to allof the instances in the managed instance group. This operation is markedDONE when you make the request even if the instances have not yet beenadded to their target pools. The change might take some time to apply toall of the instances in the group depending on the size of the group. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates a managed instance group using the information that you specifyin the request. This operation is marked as DONE when the group isupdated even if the instances in the group have not yet been updated.You must separately verify the status of the individual instances withthe listManagedInstances method. If you update your group to specify anew template or instance configuration, it's possible that your intendedspecification for each VM in the group is different from the currentstate of that VM. To learn how to apply an updated configuration to theVMs in a MIG, see Updating instances in a MIG. |
updatePerInstanceConfigs | Inserts or updates per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
Module: googleapis.compute.beta.instanceGroups
| Functions | |
|---|---|
addInstances | Adds a list of instances to the specified instance group. All of theinstances in the instance group must be in the same network/subnetwork.Read Adding instances for more information. |
aggregatedList | Retrieves the list of instance groups and sorts them by zone. |
delete | Deletes the specified instance group. The instances in the group are notdeleted. Note that instance group must not belong to a backend service.Read Deleting an instance group for more information. |
get | Returns the specified zonal instance group. Get a list of availablezonal instance groups by making a list() request. For managed instancegroups, use the instanceGroupManagers or regionInstanceGroupManagersmethods instead. |
insert | Creates an instance group in the specified project using the parametersthat are included in the request. |
list | Retrieves the list of zonal instance group resources contained withinthe specified zone. For managed instance groups, use theinstanceGroupManagers or regionInstanceGroupManagers methods instead. |
listInstances | Lists the instances in the specified instance group. The orderBy queryparameter is not supported. The filter query parameter is supported, butonly for expressions that useeq (equal) orne (not equal)operators. |
removeInstances | Removes one or more instances from the specified instance group, butdoes not delete those instances. If the group is part of a backendservice that has enabled connection draining, it can take up to 60seconds after the connection draining duration before the VM instance isremoved or deleted. |
setNamedPorts | Sets the named ports for the specified instance group. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.instanceTemplates
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all InstanceTemplates resources, regional andglobal, available to the specified project. |
delete | Deletes the specified instance template. Deleting an instance templateis permanent and cannot be undone. It is not possible to deletetemplates that are already in use by a managed instance group. |
get | Returns the specified instance template. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates an instance template in the specified project using the datathat is included in the request. If you are creating a new template toupdate an existing instance group, your new instance template must usethe same network or, if applicable, the same subnetwork as the originaltemplate. |
list | Retrieves a list of instance templates that are contained within thespecified project. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.instances
| Functions | |
|---|---|
addAccessConfig | Adds an access config to an instance's network interface. |
addResourcePolicies | Adds existing resource policies to an instance. You can only add onepolicy right now which will be applied to this instance for schedulinglive migrations. |
aggregatedList | Retrieves an aggregated list of all of the instances in your projectacross all regions and zones. The performance of this method degradeswhen a filter is specified on a project that has a very large number ofinstances. |
attachDisk | Attaches an existing Disk resource to an instance. You must first createthe disk before you can attach it. It is not possible to create andattach a disk at the same time. For more information, read Adding apersistent disk to your instance. |
bulkInsert | Creates multiple instances. Count specifies the number of instances tocreate. For more information, see About bulk creation of VMs. |
delete | Deletes the specified Instance resource. For more information, seeDeleting an instance. |
deleteAccessConfig | Deletes an access config from an instance's network interface. |
detachDisk | Detaches a disk from an instance. |
get | Returns the specified Instance resource. |
getEffectiveFirewalls | Returns effective firewalls applied to an interface of the instance. |
getGuestAttributes | Returns the specified guest attributes entry. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getScreenshot | Returns the screenshot from the specified instance. |
getSerialPortOutput | Returns the last 1 MB of serial port output from the specified instance. |
getShieldedInstanceIdentity | Returns the Shielded Instance Identity of an instance |
getShieldedVmIdentity | Returns the Shielded VM Identity of an instance |
insert | Creates an instance resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of instances contained within the specified zone. |
listReferrers | Retrieves a list of resources that refer to the VM instance specified inthe request. For example, if the VM instance is part of a managed orunmanaged instance group, the referrers list includes the instancegroup. For more information, read Viewing referrers to VM instances. |
removeResourcePolicies | Removes resource policies from an instance. |
reset | Performs a reset on the instance. This is a hard reset. The VM does notdo a graceful shutdown. For more information, see Resetting an instance. |
resume | Resumes an instance that was suspended using the instances().suspendmethod. |
sendDiagnosticInterrupt | Sends diagnostic interrupt to the instance. |
setDeletionProtection | Sets deletion protection on the instance. |
setDiskAutoDelete | Sets the auto-delete flag for a disk attached to an instance. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets labels on an instance. To learn more about labels, read theLabeling Resources documentation. |
setMachineResources | Changes the number and/or type of accelerator for a stopped instance tothe values specified in the request. |
setMachineType | Changes the machine type for a stopped instance to the machine typespecified in the request. |
setMetadata | Sets metadata for the specified instance to the data included in therequest. |
setMinCpuPlatform | Changes the minimum CPU platform that this instance should use. Thismethod can only be called on a stopped instance. For more information,read Specifying a Minimum CPU Platform. |
setName | Sets name of an instance. |
setScheduling | Sets an instance's scheduling options. You can only call this method ona stopped instance, that is, a VM instance that is in aTERMINATEDstate. See Instance Life Cycle for more information on the possibleinstance states. For more information about setting scheduling optionsfor a VM, see Set VM host maintenance policy. |
setSecurityPolicy | Sets the Google Cloud Armor security policy for the specified instance.For more information, see Google Cloud Armor Overview |
setServiceAccount | Sets the service account on the instance. For more information, readChanging the service account and access scopes for an instance. |
setShieldedInstanceIntegrityPolicy | Sets the Shielded Instance integrity policy for an instance. You canonly use this method on a running instance. This method supports PATCHsemantics and uses the JSON merge patch format and processing rules. |
setShieldedVmIntegrityPolicy | Sets the Shielded VM integrity policy for a VM instance. You can onlyuse this method on a running VM instance. This method supports PATCHsemantics and uses the JSON merge patch format and processing rules. |
setTags | Sets network tags for the specified instance to the data included in therequest. |
simulateMaintenanceEvent | Simulates a host maintenance event on a VM. For more information, seeSimulate a host maintenance event. |
start | Starts an instance that was stopped using the instances().stop method.For more information, see Restart an instance. |
startWithEncryptionKey | Starts an instance that was stopped using the instances().stop method.For more information, see Restart an instance. |
stop | Stops a running instance, shutting it down cleanly, and allows you torestart the instance at a later time. Stopped instances do not incur VMusage charges while they are stopped. However, resources that the VM isusing, such as persistent disks and static IP addresses, will continueto be charged until they are deleted. For more information, see Stoppingan instance. |
suspend | This method suspends a running instance, saving its state to persistentstorage, and allows you to resume the instance at a later time.Suspended instances have no compute costs (cores or RAM), and incur onlystorage charges for the saved VM memory and localSSD data. Any chargedresources the virtual machine was using, such as persistent disks andstatic IP addresses, will continue to be charged while the instance issuspended. For more information, see Suspending and resuming aninstance. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates an instance only if the necessary resources are available. Thismethod can update only a specific set of instance properties. SeeUpdating a running instance for a list of updatable instance properties. |
updateAccessConfig | Updates the specified access config from an instance's network interfacewith the data included in the request. This method supports PATCHsemantics and uses the JSON merge patch format and processing rules. |
updateDisplayDevice | Updates the Display config for a VM instance. You can only use thismethod on a stopped VM instance. This method supports PATCH semanticsand uses the JSON merge patch format and processing rules. |
updateNetworkInterface | Updates an instance's network interface. This method can only update aninterface's alias IP range and attached network. See Modifying alias IPranges for an existing instance for instructions on changing alias IPranges. See Migrating a VM between networks for instructions onmigrating an interface. This method follows PATCH semantics. |
updateShieldedInstanceConfig | Updates the Shielded Instance config for an instance. You can only usethis method on a stopped instance. This method supports PATCH semanticsand uses the JSON merge patch format and processing rules. |
updateShieldedVmConfig | Updates the Shielded VM config for a VM instance. You can only use thismethod on a stopped VM instance. This method supports PATCH semanticsand uses the JSON merge patch format and processing rules. |
Module: googleapis.compute.beta.instantSnapshots
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of instantSnapshots. |
delete | Deletes the specified InstantSnapshot resource. Keep in mind thatdeleting a single instantSnapshot might not necessarily delete all thedata on that instantSnapshot. If any data on the instantSnapshot that ismarked for deletion is needed for subsequent instantSnapshots, the datawill be moved to the next corresponding instantSnapshot. For moreinformation, see Deleting instantSnapshots. |
get | Returns the specified InstantSnapshot resource in the specified zone. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates an instant snapshot in the specified zone. |
list | Retrieves the list of InstantSnapshot resources contained within thespecified zone. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on a instantSnapshot in the given zone. To learn moreabout labels, read the Labeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.interconnectAttachments
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of interconnect attachments. |
delete | Deletes the specified interconnect attachment. |
get | Returns the specified interconnect attachment. |
insert | Creates an InterconnectAttachment in the specified project using thedata included in the request. |
list | Retrieves the list of interconnect attachments contained within thespecified region. |
patch | Updates the specified interconnect attachment with the data included inthe request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
setLabels | Sets the labels on an InterconnectAttachment. To learn more aboutlabels, read the Labeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.interconnectLocations
| Functions | |
|---|---|
get | Returns the details for the specified interconnect location. Gets a listof available interconnect locations by making a list() request. |
list | Retrieves the list of interconnect locations available to the specifiedproject. |
Module: googleapis.compute.beta.interconnectRemoteLocations
| Functions | |
|---|---|
get | Returns the details for the specified interconnect remote location. Getsa list of available interconnect remote locations by making a list()request. |
list | Retrieves the list of interconnect remote locations available to thespecified project. |
Module: googleapis.compute.beta.interconnects
| Functions | |
|---|---|
delete | Deletes the specified Interconnect. |
get | Returns the specified Interconnect. Get a list of availableInterconnects by making a list() request. |
getDiagnostics | Returns the interconnectDiagnostics for the specified Interconnect. |
insert | Creates an Interconnect in the specified project using the data includedin the request. |
list | Retrieves the list of Interconnects available to the specified project. |
patch | Updates the specified Interconnect with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
setLabels | Sets the labels on an Interconnect. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.licenseCodes
| Functions | |
|---|---|
get | Return a specified license code. License codes are mirrored across allprojects that have permissions to read the License Code.Caution Thisresource is intended for use only by third-party partners who arecreating Cloud Marketplace images. |
testIamPermissions | Returns permissions that a caller has on the specified resource.Caution This resource is intended for use only by third-party partnerswho are creating Cloud Marketplace images. |
Module: googleapis.compute.beta.licenses
| Functions | |
|---|---|
delete | Deletes the specified license.Caution This resource is intended foruse only by third-party partners who are creating Cloud Marketplaceimages. |
get | Returns the specified License resource.Caution This resource isintended for use only by third-party partners who are creating CloudMarketplace images. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists.Caution This resource is intended for useonly by third-party partners who are creating Cloud Marketplace images. |
insert | Create a License resource in the specified project.Caution Thisresource is intended for use only by third-party partners who arecreating Cloud Marketplace images. |
list | Retrieves the list of licenses available in the specified project. Thismethod does not get any licenses that belong to other projects,including licenses attached to publicly-available images, like Debian 9.If you want to get a list of publicly-available licenses, use thismethod to make a request to the respective image project, such asdebian-cloud or windows-cloud.Caution This resource is intended foruse only by third-party partners who are creating Cloud Marketplaceimages. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy.Caution This resource is intended for use only bythird-party partners who are creating Cloud Marketplace images. |
testIamPermissions | Returns permissions that a caller has on the specified resource.Caution This resource is intended for use only by third-party partnerswho are creating Cloud Marketplace images. |
Module: googleapis.compute.beta.machineImages
| Functions | |
|---|---|
delete | Deletes the specified machine image. Deleting a machine image ispermanent and cannot be undone. |
get | Returns the specified machine image. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a machine image in the specified project using the data that isincluded in the request. If you are creating a new machine image toupdate an existing instance, your new machine image should use the samenetwork or, if applicable, the same subnetwork as the original instance. |
list | Retrieves a list of machine images that are contained within thespecified project. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.machineTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of machine types. |
get | Returns the specified machine type. |
list | Retrieves a list of machine types available to the specified project. |
Module: googleapis.compute.beta.networkAttachments
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all NetworkAttachment resources, regional andglobal, available to the specified project. |
delete | Deletes the specified NetworkAttachment in the given scope |
get | Returns the specified NetworkAttachment resource in the given scope. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a NetworkAttachment in the specified project in the given scopeusing the parameters that are included in the request. |
list | Lists the NetworkAttachments for a project in the given scope. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.networkEdgeSecurityServices
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all NetworkEdgeSecurityService resources availableto the specified project. |
delete | Deletes the specified service. |
get | Gets a specified NetworkEdgeSecurityService. |
insert | Creates a new service in the specified project using the data includedin the request. |
patch | Patches the specified policy with the data included in the request. |
Module: googleapis.compute.beta.networkEndpointGroups
| Functions | |
|---|---|
aggregatedList | Retrieves the list of network endpoint groups and sorts them by zone. |
attachNetworkEndpoints | Attach a list of network endpoints to the specified network endpointgroup. |
delete | Deletes the specified network endpoint group. The network endpoints inthe NEG and the VM instances they belong to are not terminated when theNEG is deleted. Note that the NEG cannot be deleted if there are backendservices referencing it. |
detachNetworkEndpoints | Detach a list of network endpoints from the specified network endpointgroup. |
get | Returns the specified network endpoint group. |
insert | Creates a network endpoint group in the specified project using theparameters that are included in the request. |
list | Retrieves the list of network endpoint groups that are located in thespecified project and zone. |
listNetworkEndpoints | Lists the network endpoints in the specified network endpoint group. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.networkFirewallPolicies
| Functions | |
|---|---|
addAssociation | Inserts an association for the specified firewall policy. |
addRule | Inserts a rule into a firewall policy. |
cloneRules | Copies rules to the specified firewall policy. |
delete | Deletes the specified policy. |
get | Returns the specified network firewall policy. |
getAssociation | Gets an association with the specified name. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getRule | Gets a rule of the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | Lists all the policies that have been configured for the specifiedproject. |
patch | Patches the specified policy with the data included in the request. |
patchRule | Patches a rule of the specified priority. |
removeAssociation | Removes an association for the specified firewall policy. |
removeRule | Deletes a rule of the specified priority. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.networks
| Functions | |
|---|---|
addPeering | Adds a peering to the specified network. |
delete | Deletes the specified network. |
get | Returns the specified network. |
getEffectiveFirewalls | Returns the effective firewalls on a given network. |
insert | Creates a network in the specified project using the data included inthe request. |
list | Retrieves the list of networks available to the specified project. |
listPeeringRoutes | Lists the peering routes exchanged over peering connection. |
patch | Patches the specified network with the data included in the request.Only the following fields can be modified: routingConfig.routingMode. |
removePeering | Removes a peering from the specified network. |
switchToCustomMode | Switches the network mode from auto subnet mode to custom subnet mode. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
updatePeering | Updates the specified network peering with the data included in therequest. You can only modify the NetworkPeering.export_custom_routesfield and the NetworkPeering.import_custom_routes field. |
Module: googleapis.compute.beta.nodeGroups
| Functions | |
|---|---|
addNodes | Adds specified number of nodes to the node group. |
aggregatedList | Retrieves an aggregated list of node groups. Note: usenodeGroups.listNodes for more details about each group. |
delete | Deletes the specified NodeGroup resource. |
deleteNodes | Deletes specified nodes from the node group. |
get | Returns the specified NodeGroup. Get a list of available NodeGroups bymaking a list() request. Note: the "nodes" field should not be used.Use nodeGroups.listNodes instead. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a NodeGroup resource in the specified project using the dataincluded in the request. |
list | Retrieves a list of node groups available to the specified project.Note: use nodeGroups.listNodes for more details about each group. |
listNodes | Lists nodes in the node group. |
patch | Updates the specified node group. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setNodeTemplate | Updates the node template of the node group. |
simulateMaintenanceEvent | Simulates maintenance event on specified nodes from the node group. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.nodeTemplates
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of node templates. |
delete | Deletes the specified NodeTemplate resource. |
get | Returns the specified node template. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a NodeTemplate resource in the specified project using the dataincluded in the request. |
list | Retrieves a list of node templates available to the specified project. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.nodeTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of node types. |
get | Returns the specified node type. |
list | Retrieves a list of node types available to the specified project. |
Module: googleapis.compute.beta.organizationSecurityPolicies
| Functions | |
|---|---|
addAssociation | Inserts an association for the specified security policy. |
addRule | Inserts a rule into a security policy. |
copyRules | Copies rules to the specified security policy. |
delete | Deletes the specified policy. |
get | List all of the ordered rules present in a single specified policy. |
getAssociation | Gets an association with the specified name. |
getRule | Gets a rule at the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | List all the policies that have been configured for the specifiedproject. |
listAssociations | Lists associations of a specified target, i.e., organization or folder. |
move | Moves the specified security policy. |
patch | Patches the specified policy with the data included in the request. |
patchRule | Patches a rule at the specified priority. |
removeAssociation | Removes an association for the specified security policy. |
removeRule | Deletes a rule at the specified priority. |
Module: googleapis.compute.beta.packetMirrorings
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of packetMirrorings. |
delete | Deletes the specified PacketMirroring resource. |
get | Returns the specified PacketMirroring resource. |
insert | Creates a PacketMirroring resource in the specified project and regionusing the data included in the request. |
list | Retrieves a list of PacketMirroring resources available to the specifiedproject and region. |
patch | Patches the specified PacketMirroring resource with the data included inthe request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.projects
| Functions | |
|---|---|
disableXpnHost | Disable this project as a shared VPC host project. |
disableXpnResource | Disable a service resource (also known as service project) associatedwith this host project. |
enableXpnHost | Enable this project as a shared VPC host project. |
enableXpnResource | Enable service resource (a.k.a service project) for a host project, sothat subnets in the host project can be used by instances in the serviceproject. |
get | Returns the specified Project resource. To decrease latency for thismethod, you can optionally omit any unneeded information from theresponse by using a field mask. This practice is especially recommendedfor unused quota information (thequotas field). To exclude one ormore fields, set your request'sfields query parameter to only includethe fields you need. For example, to only include theid andselfLink fields, add the query parameter?fields=id,selfLink to yourrequest. |
getXpnHost | Gets the shared VPC host project that this project links to. May beempty if no link exists. |
getXpnResources | Gets service resources (a.k.a service project) associated with this hostproject. |
listXpnHosts | Lists all shared VPC host projects visible to the user in anorganization. |
moveDisk | Moves a persistent disk from one zone to another. |
moveInstance | Moves an instance and its attached persistent disks from one zone toanother.Note: Moving VMs or disks by using this method might causeunexpected behavior. For more information, see theknownissue.[Deprecated] This method is deprecated. Seemoving instance acrosszones instead. |
setCommonInstanceMetadata | Sets metadata common to all instances within the specified project usingthe data included in the request. |
setDefaultNetworkTier | Sets the default network tier of the project. The default network tieris used when an address/forwardingRule/instance is created withoutspecifying the network tier field. |
setUsageExportBucket | Enables the usage export feature and sets the usage export bucket wherereports are stored. If you provide an empty request body using thismethod, the usage export feature will be disabled. |
Module: googleapis.compute.beta.publicAdvertisedPrefixes
| Functions | |
|---|---|
delete | Deletes the specified PublicAdvertisedPrefix |
get | Returns the specified PublicAdvertisedPrefix resource. |
insert | Creates a PublicAdvertisedPrefix in the specified project using theparameters that are included in the request. |
list | Lists the PublicAdvertisedPrefixes for a project. |
patch | Patches the specified Router resource with the data included in therequest. This method supports PATCH semantics and uses JSON merge patchformat and processing rules. |
Module: googleapis.compute.beta.publicDelegatedPrefixes
| Functions | |
|---|---|
aggregatedList | Lists all PublicDelegatedPrefix resources owned by the specific projectacross all scopes. |
delete | Deletes the specified PublicDelegatedPrefix in the given region. |
get | Returns the specified PublicDelegatedPrefix resource in the givenregion. |
insert | Creates a PublicDelegatedPrefix in the specified project in the givenregion using the parameters that are included in the request. |
list | Lists the PublicDelegatedPrefixes for a project in the given region. |
patch | Patches the specified PublicDelegatedPrefix resource with the dataincluded in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules. |
Module: googleapis.compute.beta.regionAutoscalers
| Functions | |
|---|---|
delete | Deletes the specified autoscaler. |
get | Returns the specified autoscaler. |
insert | Creates an autoscaler in the specified project using the data includedin the request. |
list | Retrieves a list of autoscalers contained within the specified region. |
patch | Updates an autoscaler in the specified project using the data includedin the request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates an autoscaler in the specified project using the data includedin the request. |
Module: googleapis.compute.beta.regionBackendServices
| Functions | |
|---|---|
delete | Deletes the specified regional BackendService resource. |
get | Returns the specified regional BackendService resource. |
getHealth | Gets the most recent health check results for this regionalBackendService. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a regional BackendService resource in the specified projectusing the data included in the request. For more information, seeBackend services overview. |
list | Retrieves the list of regional BackendService resources available to thespecified project in the given region. |
patch | Updates the specified regional BackendService resource with the dataincluded in the request. For more information, see Understanding backendservices This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setSecurityPolicy | Sets the Google Cloud Armor security policy for the specified backendservice. For more information, see Google Cloud Armor Overview |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified regional BackendService resource with the dataincluded in the request. For more information, see Backend servicesoverview . |
Module: googleapis.compute.beta.regionCommitments
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of commitments by region. |
get | Returns the specified commitment resource. |
insert | Creates a commitment in the specified project using the data included inthe request. |
list | Retrieves a list of commitments contained within the specified region. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified commitment with the data included in the request.Update is performed only on selected fields included as part ofupdate-mask. Only the following fields can be modified: auto_renew. |
updateReservations | Transfers GPUs or local SSDs between reservations within commitments. |
Module: googleapis.compute.beta.regionDiskTypes
| Functions | |
|---|---|
get | Returns the specified regional disk type. |
list | Retrieves a list of regional disk types available to the specifiedproject. |
Module: googleapis.compute.beta.regionDisks
| Functions | |
|---|---|
addResourcePolicies | Adds existing resource policies to a regional disk. You can only add onepolicy which will be applied to this disk for scheduling snapshotcreation. |
bulkInsert | Bulk create a set of disks. |
createSnapshot | Creates a snapshot of a specified persistent disk. For regular snapshotcreation, consider using snapshots.insert instead, as that methodsupports more features, such as creating snapshots in a projectdifferent from the source disk project. |
delete | Deletes the specified regional persistent disk. Deleting a regional diskremoves all the replicas of its data permanently and is irreversible.However, deleting a disk does not delete any snapshots previously madefrom the disk. You must separately delete snapshots. |
get | Returns a specified regional persistent disk. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a persistent regional disk in the specified project using thedata included in the request. |
list | Retrieves the list of persistent disks contained within the specifiedregion. |
removeResourcePolicies | Removes resource policies from a regional disk. |
resize | Resizes the specified regional persistent disk. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on the target regional disk. |
startAsyncReplication | Starts asynchronous replication. Must be invoked on the primary disk. |
stopAsyncReplication | Stops asynchronous replication. Can be invoked either on the primary oron the secondary disk. |
stopGroupAsyncReplication | Stops asynchronous replication for a consistency group of disks. Can beinvoked either in the primary or secondary scope. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Update the specified disk with the data included in the request. Updateis performed only on selected fields included as part of update-mask.Only the following fields can be modified: user_license. |
Module: googleapis.compute.beta.regionHealthCheckServices
| Functions | |
|---|---|
delete | Deletes the specified regional HealthCheckService. |
get | Returns the specified regional HealthCheckService resource. |
insert | Creates a regional HealthCheckService resource in the specified projectand region using the data included in the request. |
list | Lists all the HealthCheckService resources that have been configured forthe specified project in the given region. |
patch | Updates the specified regional HealthCheckService resource with the dataincluded in the request. This method supports PATCH semantics and usesthe JSON merge patch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionHealthChecks
| Functions | |
|---|---|
delete | Deletes the specified HealthCheck resource. |
get | Returns the specified HealthCheck resource. |
insert | Creates a HealthCheck resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of HealthCheck resources available to the specifiedproject. |
patch | Updates a HealthCheck resource in the specified project using the dataincluded in the request. This method supports PATCH semantics and usesthe JSON merge patch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates a HealthCheck resource in the specified project using the dataincluded in the request. |
Module: googleapis.compute.beta.regionInstanceGroupManagers
| Functions | |
|---|---|
abandonInstances | Flags the specified instances to be immediately removed from the managedinstance group. Abandoning an instance does not delete the instance, butit does remove the instance from any target pools that are applied bythe managed instance group. This method reduces the targetSize of themanaged instance group by the number of instances that you abandon. Thisoperation is marked as DONE when the action is scheduled even if theinstances have not yet been removed from the group. You must separatelyverify the status of the abandoning action with the listmanagedinstancesmethod. If the group is part of a backend service that has enabledconnection draining, it can take up to 60 seconds after the connectiondraining duration has elapsed before the VM instance is removed ordeleted. You can specify a maximum of 1000 instances with this methodper request. |
applyUpdatesToInstances | Apply updates to selected instances the managed instance group. |
createInstances | Creates instances with per-instance configurations in this regionalmanaged instance group. Instances are created using the current instancetemplate. The create instances operation is marked DONE if thecreateInstances request is successful. The underlying actions takeadditional time. You must separately verify the status of the creatingor actions with the listmanagedinstances method. |
delete | Deletes the specified managed instance group and all of the instances inthat group. |
deleteInstances | Flags the specified instances in the managed instance group to beimmediately deleted. The instances are also removed from any targetpools of which they were a member. This method reduces the targetSize ofthe managed instance group by the number of instances that you delete.The deleteInstances operation is marked DONE if the deleteInstancesrequest is successful. The underlying actions take additional time. Youmust separately verify the status of the deleting action with thelistmanagedinstances method. If the group is part of a backend servicethat has enabled connection draining, it can take up to 60 seconds afterthe connection draining duration has elapsed before the VM instance isremoved or deleted. You can specify a maximum of 1000 instances withthis method per request. |
deletePerInstanceConfigs | Deletes selected per-instance configurations for the managed instancegroup. |
get | Returns all of the details about the specified managed instance group. |
insert | Creates a managed instance group using the information that you specifyin the request. After the group is created, instances in the group arecreated using the specified instance template. This operation is markedas DONE when the group is created even if the instances in the grouphave not yet been created. You must separately verify the status of theindividual instances with the listmanagedinstances method. A regionalmanaged instance group can contain up to 2000 instances. |
list | Retrieves the list of managed instance groups that are contained withinthe specified region. |
listErrors | Lists all errors thrown by actions on instances for a given regionalmanaged instance group. The filter and orderBy query parameters are notsupported. |
listManagedInstances | Lists the instances in the managed instance group and instances that arescheduled to be created. The list includes any current actions that thegroup has scheduled for its instances. The orderBy query parameter isnot supported. ThepageToken query parameter is supported only in thealpha and beta API and only if the group'slistManagedInstancesResultsfield is set toPAGINATED. |
listPerInstanceConfigs | Lists all of the per-instance configurations defined for the managedinstance group. The orderBy query parameter is not supported. |
patch | Updates a managed instance group using the information that you specifyin the request. This operation is marked as DONE when the group ispatched even if the instances in the group are still in the process ofbeing patched. You must separately verify the status of the individualinstances with the listmanagedinstances method. This method supportsPATCH semantics and uses the JSON merge patch format and processingrules. If you update your group to specify a new template or instanceconfiguration, it's possible that your intended specification for eachVM in the group is different from the current state of that VM. To learnhow to apply an updated configuration to the VMs in a MIG, see Updatinginstances in a MIG. |
patchPerInstanceConfigs | Inserts or patches per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
recreateInstances | Flags the specified VM instances in the managed instance group to beimmediately recreated. Each instance is recreated using the group'scurrent configuration. This operation is marked as DONE when the flag isset even if the instances have not yet been recreated. You mustseparately verify the status of each instance by checking itscurrentAction field; for more information, see Checking the status ofmanaged instances. If the group is part of a backend service that hasenabled connection draining, it can take up to 60 seconds after theconnection draining duration has elapsed before the VM instance isremoved or deleted. You can specify a maximum of 1000 instances withthis method per request. |
resize | Changes the intended size of the managed instance group. If you increasethe size, the group creates new instances using the current instancetemplate. If you decrease the size, the group deletes one or moreinstances. The resize operation is marked DONE if the resize request issuccessful. The underlying actions take additional time. You mustseparately verify the status of the creating or deleting actions withthe listmanagedinstances method. If the group is part of a backendservice that has enabled connection draining, it can take up to 60seconds after the connection draining duration has elapsed before the VMinstance is removed or deleted. |
resizeAdvanced | Resizes the regional managed instance group with advanced configurationoptions like disabling creation retries. This is an extended version ofthe resize method. If you increase the size, the group creates newinstances using the current instance template. If you decrease the size,the group deletes one or more instances. The resize operation is markedDONE if the resize request is successful. The underlying actions takeadditional time. You must separately verify the status of the creatingor deleting actions with the get or listmanagedinstances method. If thegroup is part of a backend service that has enabled connection draining,it can take up to 60 seconds after the connection draining duration haselapsed before the VM instance is removed or deleted. |
setAutoHealingPolicies | Modifies the autohealing policy for the instances in this managedinstance group. [Deprecated] This method is deprecated. UseregionInstanceGroupManagers.patch instead. |
setInstanceTemplate | Sets the instance template to use when creating new instances orrecreating instances in this group. Existing instances are not affected. |
setTargetPools | Modifies the target pools to which all new instances in this group areassigned. Existing instances in the group are not affected. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates a managed instance group using the information that you specifyin the request. This operation is marked as DONE when the group isupdated even if the instances in the group have not yet been updated.You must separately verify the status of the individual instances withthe listmanagedinstances method. If you update your group to specify anew template or instance configuration, it's possible that your intendedspecification for each VM in the group is different from the currentstate of that VM. To learn how to apply an updated configuration to theVMs in a MIG, see Updating instances in a MIG. |
updatePerInstanceConfigs | Inserts or updates per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
Module: googleapis.compute.beta.regionInstanceGroups
| Functions | |
|---|---|
get | Returns the specified instance group resource. |
list | Retrieves the list of instance group resources contained within thespecified region. |
listInstances | Lists the instances in the specified instance group and displaysinformation about the named ports. Depending on the specified options,this method can list all instances or only the instances that arerunning. The orderBy query parameter is not supported. |
setNamedPorts | Sets the named ports for the specified regional instance group. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionInstanceTemplates
| Functions | |
|---|---|
delete | Deletes the specified instance template. Deleting an instance templateis permanent and cannot be undone. |
get | Returns the specified instance template. |
insert | Creates an instance template in the specified project and region usingthe global instance template whose URL is included in the request. |
list | Retrieves a list of instance templates that are contained within thespecified project and region. |
Module: googleapis.compute.beta.regionInstances
| Functions | |
|---|---|
bulkInsert | Creates multiple instances in a given region. Count specifies the numberof instances to create. |
Module: googleapis.compute.beta.regionInstantSnapshots
| Functions | |
|---|---|
delete | Deletes the specified InstantSnapshot resource. Keep in mind thatdeleting a single instantSnapshot might not necessarily delete all thedata on that instantSnapshot. If any data on the instantSnapshot that ismarked for deletion is needed for subsequent instantSnapshots, the datawill be moved to the next corresponding instantSnapshot. For moreinformation, see Deleting instantSnapshots. |
get | Returns the specified InstantSnapshot resource in the specified region. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates an instant snapshot in the specified region. |
list | Retrieves the list of InstantSnapshot resources contained within thespecified region. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on a instantSnapshot in the given region. To learn moreabout labels, read the Labeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionNetworkEndpointGroups
| Functions | |
|---|---|
delete | Deletes the specified network endpoint group. Note that the NEG cannotbe deleted if it is configured as a backend of a backend service. |
get | Returns the specified network endpoint group. |
insert | Creates a network endpoint group in the specified project using theparameters that are included in the request. |
list | Retrieves the list of regional network endpoint groups available to thespecified project in the given region. |
Module: googleapis.compute.beta.regionNetworkFirewallPolicies
| Functions | |
|---|---|
addAssociation | Inserts an association for the specified network firewall policy. |
addRule | Inserts a rule into a network firewall policy. |
cloneRules | Copies rules to the specified network firewall policy. |
delete | Deletes the specified network firewall policy. |
get | Returns the specified network firewall policy. |
getAssociation | Gets an association with the specified name. |
getEffectiveFirewalls | Returns the effective firewalls on a given network. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getRule | Gets a rule of the specified priority. |
insert | Creates a new network firewall policy in the specified project andregion. |
list | Lists all the network firewall policies that have been configured forthe specified project in the given region. |
patch | Patches the specified network firewall policy. |
patchRule | Patches a rule of the specified priority. |
removeAssociation | Removes an association for the specified network firewall policy. |
removeRule | Deletes a rule of the specified priority. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionNotificationEndpoints
| Functions | |
|---|---|
delete | Deletes the specified NotificationEndpoint in the given region |
get | Returns the specified NotificationEndpoint resource in the given region. |
insert | Create a NotificationEndpoint in the specified project in the givenregion using the parameters that are included in the request. |
list | Lists the NotificationEndpoints for a project in the given region. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionOperations
| Functions | |
|---|---|
delete | Deletes the specified region-specific Operations resource. |
get | Retrieves the specified region-specific Operations resource. |
list | Retrieves a list of Operation resources contained within the specifiedregion. |
wait | Waits for the specified Operation resource to return asDONE or forthe request to approach the 2 minute deadline, and retrieves thespecified Operation resource. This method differs from theGET methodin that it waits for no more than the default deadline (2 minutes) andthen returns the current state of the operation, which might beDONEor still in progress. This method is called on a best-effort basis.Specifically: - In uncommon cases, when the server is overloaded, therequest might return before the default deadline is reached, or mightreturn after zero seconds. - If the default deadline is reached, thereis no guarantee that the operation is actually done when the methodreturns. Be prepared to retry if the operation is notDONE. |
Module: googleapis.compute.beta.regionSecurityPolicies
| Functions | |
|---|---|
addRule | Inserts a rule into a security policy. |
delete | Deletes the specified policy. |
get | List all of the ordered rules present in a single specified policy. |
getRule | Gets a rule at the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | List all the policies that have been configured for the specifiedproject and region. |
patch | Patches the specified policy with the data included in the request. Toclear fields in the policy, leave the fields empty and specify them inthe updateMask. This cannot be used to be update the rules in thepolicy. Please use the per rule methods like addRule, patchRule, andremoveRule instead. |
patchRule | Patches a rule at the specified priority. To clear fields in the rule,leave the fields empty and specify them in the updateMask. |
removeRule | Deletes a rule at the specified priority. |
Module: googleapis.compute.beta.regionSslCertificates
| Functions | |
|---|---|
delete | Deletes the specified SslCertificate resource in the region. |
get | Returns the specified SslCertificate resource in the specified region.Get a list of available SSL certificates by making a list() request. |
insert | Creates a SslCertificate resource in the specified project and regionusing the data included in the request |
list | Retrieves the list of SslCertificate resources available to thespecified project in the specified region. |
testIamPermissions | Returns permissions that a caller has on the specified resource andregion. |
Module: googleapis.compute.beta.regionSslPolicies
| Functions | |
|---|---|
delete | Deletes the specified SSL policy. The SSL policy resource can be deletedonly if it is not in use by any TargetHttpsProxy or TargetSslProxyresources. |
get | Lists all of the ordered rules present in a single specified policy. |
insert | Creates a new policy in the specified project and region using the dataincluded in the request. |
list | Lists all the SSL policies that have been configured for the specifiedproject and region. |
listAvailableFeatures | Lists all features that can be specified in the SSL policy when usingcustom profile. |
patch | Patches the specified SSL policy with the data included in the request. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionTargetHttpProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetHttpProxy resource. |
get | Returns the specified TargetHttpProxy resource in the specified region. |
insert | Creates a TargetHttpProxy resource in the specified project and regionusing the data included in the request. |
list | Retrieves the list of TargetHttpProxy resources available to thespecified project in the specified region. |
setUrlMap | Changes the URL map for TargetHttpProxy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionTargetHttpsProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetHttpsProxy resource. |
get | Returns the specified TargetHttpsProxy resource in the specified region. |
insert | Creates a TargetHttpsProxy resource in the specified project and regionusing the data included in the request. |
list | Retrieves the list of TargetHttpsProxy resources available to thespecified project in the specified region. |
patch | Patches the specified regional TargetHttpsProxy resource with the dataincluded in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules. |
setSslCertificates | Replaces SslCertificates for TargetHttpsProxy. |
setUrlMap | Changes the URL map for TargetHttpsProxy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionTargetTcpProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetTcpProxy resource. |
get | Returns the specified TargetTcpProxy resource. |
insert | Creates a TargetTcpProxy resource in the specified project and regionusing the data included in the request. |
list | Retrieves a list of TargetTcpProxy resources available to the specifiedproject in a given region. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.regionUrlMaps
| Functions | |
|---|---|
delete | Deletes the specified UrlMap resource. |
get | Returns the specified UrlMap resource. |
insert | Creates a UrlMap resource in the specified project using the dataincluded in the request. |
invalidateCache | Initiates a cache invalidation operation, invalidating the specifiedpath, scoped to the specified UrlMap. For more information, seeInvalidating cached content. |
list | Retrieves the list of UrlMap resources available to the specifiedproject in the specified region. |
patch | Patches the specified UrlMap resource with the data included in therequest. This method supports PATCH semantics and uses JSON merge patchformat and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified UrlMap resource with the data included in therequest. |
validate | Runs static validation for the UrlMap. In particular, the tests of theprovided UrlMap will be run. Calling this method does NOT create theUrlMap. |
Module: googleapis.compute.beta.regions
| Functions | |
|---|---|
get | Returns the specified Region resource. To decrease latency for thismethod, you can optionally omit any unneeded information from theresponse by using a field mask. This practice is especially recommendedfor unused quota information (thequotas field). To exclude one ormore fields, set your request'sfields query parameter to only includethe fields you need. For example, to only include theid andselfLink fields, add the query parameter?fields=id,selfLink to yourrequest. |
list | Retrieves the list of region resources available to the specifiedproject. To decrease latency for this method, you can optionally omitany unneeded information from the response by using a field mask. Thispractice is especially recommended for unused quota information (theitems.quotas field). To exclude one or more fields, set your request'sfields query parameter to only include the fields you need. Forexample, to only include theid andselfLink fields, add the queryparameter?fields=id,selfLink to your request. |
Module: googleapis.compute.beta.reservations
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of reservations. |
delete | Deletes the specified reservation. |
get | Retrieves information about the specified reservation. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a new reservation. For more information, read Reserving zonalresources. |
list | A list of all the reservations that have been configured for thespecified project in specified zone. |
resize | Resizes the reservation (applicable to standalone reservations only).For more information, read Modifying reservations. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Update share settings of the reservation. |
Module: googleapis.compute.beta.resourcePolicies
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of resource policies. |
delete | Deletes the specified resource policy. |
get | Retrieves all information of the specified resource policy. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a new resource policy. |
list | A list all the resource policies that have been configured for thespecified project in specified region. |
patch | Modify the specified resource policy. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.routers
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of routers. |
delete | Deletes the specified Router resource. |
get | Returns the specified Router resource. |
getNatMappingInfo | Retrieves runtime Nat mapping information of VM endpoints. |
getRouterStatus | Retrieves runtime information of the specified router. |
insert | Creates a Router resource in the specified project and region using thedata included in the request. |
list | Retrieves a list of Router resources available to the specified project. |
patch | Patches the specified Router resource with the data included in therequest. This method supports PATCH semantics and uses JSON merge patchformat and processing rules. |
preview | Preview fields auto-generated during router create and updateoperations. Calling this method does NOT create or update the router. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified Router resource with the data included in therequest. This method conforms to PUT semantics, which requests that thestate of the target resource be created or replaced with the statedefined by the representation enclosed in the request message payload. |
Module: googleapis.compute.beta.routes
| Functions | |
|---|---|
delete | Deletes the specified Route resource. |
get | Returns the specified Route resource. |
insert | Creates a Route resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of Route resources available to the specifiedproject. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.securityPolicies
| Functions | |
|---|---|
addRule | Inserts a rule into a security policy. |
aggregatedList | Retrieves the list of all SecurityPolicy resources, regional and global,available to the specified project. |
delete | Deletes the specified policy. |
get | List all of the ordered rules present in a single specified policy. |
getRule | Gets a rule at the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | List all the policies that have been configured for the specifiedproject. |
listPreconfiguredExpressionSets | Gets the current list of preconfigured Web Application Firewall (WAF)expressions. |
patch | Patches the specified policy with the data included in the request. Toclear fields in the policy, leave the fields empty and specify them inthe updateMask. This cannot be used to be update the rules in thepolicy. Please use the per rule methods like addRule, patchRule, andremoveRule instead. |
patchRule | Patches a rule at the specified priority. To clear fields in the rule,leave the fields empty and specify them in the updateMask. |
removeRule | Deletes a rule at the specified priority. |
setLabels | Sets the labels on a security policy. To learn more about labels, readthe Labeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.serviceAttachments
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all ServiceAttachment resources, regional andglobal, available to the specified project. |
delete | Deletes the specified ServiceAttachment in the given scope |
get | Returns the specified ServiceAttachment resource in the given scope. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a ServiceAttachment in the specified project in the given scopeusing the parameters that are included in the request. |
list | Lists the ServiceAttachments for a project in the given scope. |
patch | Patches the specified ServiceAttachment resource with the data includedin the request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.snapshots
| Functions | |
|---|---|
delete | Deletes the specified Snapshot resource. Keep in mind that deleting asingle snapshot might not necessarily delete all the data on thatsnapshot. If any data on the snapshot that is marked for deletion isneeded for subsequent snapshots, the data will be moved to the nextcorresponding snapshot. For more information, see Deleting snapshots. |
get | Returns the specified Snapshot resource. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a snapshot in the specified project using the data included inthe request. For regular snapshot creation, consider using this methodinstead of disks.createSnapshot, as this method supports more features,such as creating snapshots in a project different from the source diskproject. |
list | Retrieves the list of Snapshot resources contained within the specifiedproject. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on a snapshot. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.sslCertificates
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all SslCertificate resources, regional and global,available to the specified project. |
delete | Deletes the specified SslCertificate resource. |
get | Returns the specified SslCertificate resource. |
insert | Creates a SslCertificate resource in the specified project using thedata included in the request. |
list | Retrieves the list of SslCertificate resources available to thespecified project. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.sslPolicies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all SslPolicy resources, regional and global,available to the specified project. |
delete | Deletes the specified SSL policy. The SSL policy resource can be deletedonly if it is not in use by any TargetHttpsProxy or TargetSslProxyresources. |
get | Lists all of the ordered rules present in a single specified policy. |
insert | Returns the specified SSL policy resource. |
list | Lists all the SSL policies that have been configured for the specifiedproject. |
listAvailableFeatures | Lists all features that can be specified in the SSL policy when usingcustom profile. |
patch | Patches the specified SSL policy with the data included in the request. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.subnetworks
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of subnetworks. |
delete | Deletes the specified subnetwork. |
expandIpCidrRange | Expands the IP CIDR range of the subnetwork to a specified value. |
get | Returns the specified subnetwork. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a subnetwork in the specified project using the data included inthe request. |
list | Retrieves a list of subnetworks available to the specified project. |
listUsable | Retrieves an aggregated list of all usable subnetworks in the project. |
patch | Patches the specified subnetwork with the data included in the request.Only certain fields can be updated with a patch request as indicated inthe field descriptions. You must specify the current fingerprint of thesubnetwork resource being patched. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setPrivateIpGoogleAccess | Set whether VMs in this subnet can access Google services withoutassigning external IP addresses through Private Google Access. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetGrpcProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetGrpcProxy in the given scope |
get | Returns the specified TargetGrpcProxy resource in the given scope. |
insert | Creates a TargetGrpcProxy in the specified project in the given scopeusing the parameters that are included in the request. |
list | Lists the TargetGrpcProxies for a project in the given scope. |
patch | Patches the specified TargetGrpcProxy resource with the data included inthe request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetHttpProxies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all TargetHttpProxy resources, regional andglobal, available to the specified project. |
delete | Deletes the specified TargetHttpProxy resource. |
get | Returns the specified TargetHttpProxy resource. |
insert | Creates a TargetHttpProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetHttpProxy resources available to thespecified project. |
patch | Patches the specified TargetHttpProxy resource with the data included inthe request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
setUrlMap | Changes the URL map for TargetHttpProxy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetHttpsProxies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all TargetHttpsProxy resources, regional andglobal, available to the specified project. |
delete | Deletes the specified TargetHttpsProxy resource. |
get | Returns the specified TargetHttpsProxy resource. |
insert | Creates a TargetHttpsProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetHttpsProxy resources available to thespecified project. |
patch | Patches the specified TargetHttpsProxy resource with the data includedin the request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
setCertificateMap | Changes the Certificate Map for TargetHttpsProxy. |
setQuicOverride | Sets the QUIC override policy for TargetHttpsProxy. |
setSslCertificates | Replaces SslCertificates for TargetHttpsProxy. |
setSslPolicy | Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies theserver-side support for SSL features. This affects connections betweenclients and the HTTPS proxy load balancer. They do not affect theconnection between the load balancer and the backends. |
setUrlMap | Changes the URL map for TargetHttpsProxy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetInstances
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of target instances. |
delete | Deletes the specified TargetInstance resource. |
get | Returns the specified TargetInstance resource. |
insert | Creates a TargetInstance resource in the specified project and zoneusing the data included in the request. |
list | Retrieves a list of TargetInstance resources available to the specifiedproject and zone. |
setSecurityPolicy | Sets the Google Cloud Armor security policy for the specified targetinstance. For more information, see Google Cloud Armor Overview |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetPools
| Functions | |
|---|---|
addHealthCheck | Adds health check URLs to a target pool. |
addInstance | Adds an instance to a target pool. |
aggregatedList | Retrieves an aggregated list of target pools. |
delete | Deletes the specified target pool. |
get | Returns the specified target pool. |
getHealth | Gets the most recent health check results for each IP for the instancethat is referenced by the given target pool. |
insert | Creates a target pool in the specified project and region using the dataincluded in the request. |
list | Retrieves a list of target pools available to the specified project andregion. |
removeHealthCheck | Removes health check URL from a target pool. |
removeInstance | Removes instance URL from a target pool. |
setBackup | Changes a backup target pool's configurations. |
setSecurityPolicy | Sets the Google Cloud Armor security policy for the specified targetpool. For more information, see Google Cloud Armor Overview |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetSslProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetSslProxy resource. |
get | Returns the specified TargetSslProxy resource. |
insert | Creates a TargetSslProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetSslProxy resources available to thespecified project. |
setBackendService | Changes the BackendService for TargetSslProxy. |
setCertificateMap | Changes the Certificate Map for TargetSslProxy. |
setProxyHeader | Changes the ProxyHeaderType for TargetSslProxy. |
setSslCertificates | Changes SslCertificates for TargetSslProxy. |
setSslPolicy | Sets the SSL policy for TargetSslProxy. The SSL policy specifies theserver-side support for SSL features. This affects connections betweenclients and the SSL proxy load balancer. They do not affect theconnection between the load balancer and the backends. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetTcpProxies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all TargetTcpProxy resources, regional and global,available to the specified project. |
delete | Deletes the specified TargetTcpProxy resource. |
get | Returns the specified TargetTcpProxy resource. |
insert | Creates a TargetTcpProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetTcpProxy resources available to thespecified project. |
setBackendService | Changes the BackendService for TargetTcpProxy. |
setProxyHeader | Changes the ProxyHeaderType for TargetTcpProxy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.targetVpnGateways
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of target VPN gateways. |
delete | Deletes the specified target VPN gateway. |
get | Returns the specified target VPN gateway. |
insert | Creates a target VPN gateway in the specified project and region usingthe data included in the request. |
list | Retrieves a list of target VPN gateways available to the specifiedproject and region. |
setLabels | Sets the labels on a TargetVpnGateway. To learn more about labels, readthe Labeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.urlMaps
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all UrlMap resources, regional and global,available to the specified project. |
delete | Deletes the specified UrlMap resource. |
get | Returns the specified UrlMap resource. |
insert | Creates a UrlMap resource in the specified project using the dataincluded in the request. |
invalidateCache | Initiates a cache invalidation operation, invalidating the specifiedpath, scoped to the specified UrlMap. For more information, seeInvalidating cached content. |
list | Retrieves the list of UrlMap resources available to the specifiedproject. |
patch | Patches the specified UrlMap resource with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified UrlMap resource with the data included in therequest. |
validate | Runs static validation for the UrlMap. In particular, the tests of theprovided UrlMap will be run. Calling this method does NOT create theUrlMap. |
Module: googleapis.compute.beta.vpnGateways
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of VPN gateways. |
delete | Deletes the specified VPN gateway. |
get | Returns the specified VPN gateway. |
getStatus | Returns the status for the specified VPN gateway. |
insert | Creates a VPN gateway in the specified project and region using the dataincluded in the request. |
list | Retrieves a list of VPN gateways available to the specified project andregion. |
setLabels | Sets the labels on a VpnGateway. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.vpnTunnels
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of VPN tunnels. |
delete | Deletes the specified VpnTunnel resource. |
get | Returns the specified VpnTunnel resource. |
insert | Creates a VpnTunnel resource in the specified project and region usingthe data included in the request. |
list | Retrieves a list of VpnTunnel resources contained in the specifiedproject and region. |
setLabels | Sets the labels on a VpnTunnel. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.beta.zoneOperations
| Functions | |
|---|---|
delete | Deletes the specified zone-specific Operations resource. |
get | Retrieves the specified zone-specific Operations resource. |
list | Retrieves a list of Operation resources contained within the specifiedzone. |
wait | Waits for the specified Operation resource to return asDONE or forthe request to approach the 2 minute deadline, and retrieves thespecified Operation resource. This method waits for no more than the 2minutes and then returns the current state of the operation, which mightbeDONE or still in progress. This method is called on a best-effortbasis. Specifically: - In uncommon cases, when the server is overloaded,the request might return before the default deadline is reached, ormight return after zero seconds. - If the default deadline is reached,there is no guarantee that the operation is actually done when themethod returns. Be prepared to retry if the operation is notDONE. |
Module: googleapis.compute.beta.zones
| Functions | |
|---|---|
get | Returns the specified Zone resource. |
list | Retrieves the list of Zone resources available to the specified project. |
Module: googleapis.compute.v1.acceleratorTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of accelerator types. |
get | Returns the specified accelerator type. |
list | Retrieves a list of accelerator types that are available to thespecified project. |
Module: googleapis.compute.v1.addresses
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of addresses. |
delete | Deletes the specified address resource. |
get | Returns the specified address resource. |
insert | Creates an address resource in the specified project by using the dataincluded in the request. |
list | Retrieves a list of addresses contained within the specified region. |
move | Moves the specified address resource. |
setLabels | Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation. |
Module: googleapis.compute.v1.autoscalers
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of autoscalers. |
delete | Deletes the specified autoscaler. |
get | Returns the specified autoscaler resource. |
insert | Creates an autoscaler in the specified project using the data includedin the request. |
list | Retrieves a list of autoscalers contained within the specified zone. |
patch | Updates an autoscaler in the specified project using the data includedin the request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
update | Updates an autoscaler in the specified project using the data includedin the request. |
Module: googleapis.compute.v1.backendBuckets
| Functions | |
|---|---|
addSignedUrlKey | Adds a key for validating requests with signed URLs for this backendbucket. |
delete | Deletes the specified BackendBucket resource. |
deleteSignedUrlKey | Deletes a key for validating requests with signed URLs for this backendbucket. |
get | Returns the specified BackendBucket resource. |
insert | Creates a BackendBucket resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of BackendBucket resources available to the specifiedproject. |
patch | Updates the specified BackendBucket resource with the data included inthe request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
setEdgeSecurityPolicy | Sets the edge security policy for the specified backend bucket. |
update | Updates the specified BackendBucket resource with the data included inthe request. |
Module: googleapis.compute.v1.backendServices
| Functions | |
|---|---|
addSignedUrlKey | Adds a key for validating requests with signed URLs for this backendservice. |
aggregatedList | Retrieves the list of all BackendService resources, regional and global,available to the specified project. |
delete | Deletes the specified BackendService resource. |
deleteSignedUrlKey | Deletes a key for validating requests with signed URLs for this backendservice. |
get | Returns the specified BackendService resource. |
getHealth | Gets the most recent health check results for this BackendService.Example request body: { "group":"/zones/us-east1-b/instanceGroups/lb-backend-example" } |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a BackendService resource in the specified project using thedata included in the request. For more information, see Backend servicesoverview . |
list | Retrieves the list of BackendService resources available to thespecified project. |
patch | Patches the specified BackendService resource with the data included inthe request. For more information, see Backend services overview. Thismethod supports PATCH semantics and uses the JSON merge patch format andprocessing rules. |
setEdgeSecurityPolicy | Sets the edge security policy for the specified backend service. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setSecurityPolicy | Sets the Google Cloud Armor security policy for the specified backendservice. For more information, see Google Cloud Armor Overview |
update | Updates the specified BackendService resource with the data included inthe request. For more information, see Backend services overview. |
Module: googleapis.compute.v1.diskTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of disk types. |
get | Returns the specified disk type. |
list | Retrieves a list of disk types available to the specified project. |
Module: googleapis.compute.v1.disks
| Functions | |
|---|---|
addResourcePolicies | Adds existing resource policies to a disk. You can only add one policywhich will be applied to this disk for scheduling snapshot creation. |
aggregatedList | Retrieves an aggregated list of persistent disks. |
bulkInsert | Bulk create a set of disks. |
createSnapshot | Creates a snapshot of a specified persistent disk. For regular snapshotcreation, consider using snapshots.insert instead, as that methodsupports more features, such as creating snapshots in a projectdifferent from the source disk project. |
delete | Deletes the specified persistent disk. Deleting a disk removes its datapermanently and is irreversible. However, deleting a disk does notdelete any snapshots previously made from the disk. You must separatelydelete snapshots. |
get | Returns the specified persistent disk. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a persistent disk in the specified project using the data in therequest. You can create a disk from a source (sourceImage,sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk byomitting all properties. You can also create a disk that is larger thanthe default size by specifying the sizeGb property. |
list | Retrieves a list of persistent disks contained within the specifiedzone. |
removeResourcePolicies | Removes resource policies from a disk. |
resize | Resizes the specified persistent disk. You can only increase the size ofthe disk. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on a disk. To learn more about labels, read the LabelingResources documentation. |
startAsyncReplication | Starts asynchronous replication. Must be invoked on the primary disk. |
stopAsyncReplication | Stops asynchronous replication. Can be invoked either on the primary oron the secondary disk. |
stopGroupAsyncReplication | Stops asynchronous replication for a consistency group of disks. Can beinvoked either in the primary or secondary scope. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates the specified disk with the data included in the request. Theupdate is performed only on selected fields included as part ofupdate-mask. Only the following fields can be modified: user_license. |
Module: googleapis.compute.v1.externalVpnGateways
| Functions | |
|---|---|
delete | Deletes the specified externalVpnGateway. |
get | Returns the specified externalVpnGateway. Get a list of availableexternalVpnGateways by making a list() request. |
insert | Creates a ExternalVpnGateway in the specified project using the dataincluded in the request. |
list | Retrieves the list of ExternalVpnGateway available to the specifiedproject. |
setLabels | Sets the labels on an ExternalVpnGateway. To learn more about labels,read the Labeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.firewallPolicies
| Functions | |
|---|---|
addAssociation | Inserts an association for the specified firewall policy. |
addRule | Inserts a rule into a firewall policy. |
cloneRules | Copies rules to the specified firewall policy. |
delete | Deletes the specified policy. |
get | Returns the specified firewall policy. |
getAssociation | Gets an association with the specified name. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getRule | Gets a rule of the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | Lists all the policies that have been configured for the specifiedfolder or organization. |
listAssociations | Lists associations of a specified target, i.e., organization or folder. |
move | Moves the specified firewall policy. |
patch | Patches the specified policy with the data included in the request. |
patchRule | Patches a rule of the specified priority. |
removeAssociation | Removes an association for the specified firewall policy. |
removeRule | Deletes a rule of the specified priority. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.firewalls
| Functions | |
|---|---|
delete | Deletes the specified firewall. |
get | Returns the specified firewall. |
insert | Creates a firewall rule in the specified project using the data includedin the request. |
list | Retrieves the list of firewall rules available to the specified project. |
patch | Updates the specified firewall rule with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
update | Updates the specified firewall rule with the data included in therequest. Note that all fields will be updated if using PUT, even fieldsthat are not specified. To update individual fields, please use PATCHinstead. |
Module: googleapis.compute.v1.forwardingRules
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of forwarding rules. |
delete | Deletes the specified ForwardingRule resource. |
get | Returns the specified ForwardingRule resource. |
insert | Creates a ForwardingRule resource in the specified project and regionusing the data included in the request. |
list | Retrieves a list of ForwardingRule resources available to the specifiedproject and region. |
patch | Updates the specified forwarding rule with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. Currently, you can only patch thenetwork_tier field. |
setLabels | Sets the labels on the specified resource. To learn more about labels,read the Labeling Resources documentation. |
setTarget | Changes target URL for forwarding rule. The new target should be of thesame type as the old target. |
Module: googleapis.compute.v1.globalAddresses
| Functions | |
|---|---|
delete | Deletes the specified address resource. |
get | Returns the specified address resource. |
insert | Creates an address resource in the specified project by using the dataincluded in the request. |
list | Retrieves a list of global addresses. |
move | Moves the specified address resource from one project to anotherproject. |
setLabels | Sets the labels on a GlobalAddress. To learn more about labels, read theLabeling Resources documentation. |
Module: googleapis.compute.v1.globalForwardingRules
| Functions | |
|---|---|
delete | Deletes the specified GlobalForwardingRule resource. |
get | Returns the specified GlobalForwardingRule resource. Gets a list ofavailable forwarding rules by making a list() request. |
insert | Creates a GlobalForwardingRule resource in the specified project usingthe data included in the request. |
list | Retrieves a list of GlobalForwardingRule resources available to thespecified project. |
patch | Updates the specified forwarding rule with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. Currently, you can only patch thenetwork_tier field. |
setLabels | Sets the labels on the specified resource. To learn more about labels,read the Labeling resources documentation. |
setTarget | Changes target URL for the GlobalForwardingRule resource. The new targetshould be of the same type as the old target. |
Module: googleapis.compute.v1.globalNetworkEndpointGroups
| Functions | |
|---|---|
attachNetworkEndpoints | Attach a network endpoint to the specified network endpoint group. |
delete | Deletes the specified network endpoint group.Note that the NEG cannot bedeleted if there are backend services referencing it. |
detachNetworkEndpoints | Detach the network endpoint from the specified network endpoint group. |
get | Returns the specified network endpoint group. |
insert | Creates a network endpoint group in the specified project using theparameters that are included in the request. |
list | Retrieves the list of network endpoint groups that are located in thespecified project. |
listNetworkEndpoints | Lists the network endpoints in the specified network endpoint group. |
Module: googleapis.compute.v1.globalOperations
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of all operations. |
delete | Deletes the specified Operations resource. |
get | Retrieves the specified Operations resource. |
list | Retrieves a list of Operation resources contained within the specifiedproject. |
wait | Waits for the specified Operation resource to return asDONE or forthe request to approach the 2 minute deadline, and retrieves thespecified Operation resource. This method differs from theGET methodin that it waits for no more than the default deadline (2 minutes) andthen returns the current state of the operation, which might beDONEor still in progress. This method is called on a best-effort basis.Specifically: - In uncommon cases, when the server is overloaded, therequest might return before the default deadline is reached, or mightreturn after zero seconds. - If the default deadline is reached, thereis no guarantee that the operation is actually done when the methodreturns. Be prepared to retry if the operation is notDONE. |
Module: googleapis.compute.v1.globalOrganizationOperations
| Functions | |
|---|---|
delete | Deletes the specified Operations resource. |
get | Retrieves the specified Operations resource. Gets a list of operationsby making alist() request. |
list | Retrieves a list of Operation resources contained within the specifiedorganization. |
Module: googleapis.compute.v1.globalPublicDelegatedPrefixes
| Functions | |
|---|---|
delete | Deletes the specified global PublicDelegatedPrefix. |
get | Returns the specified global PublicDelegatedPrefix resource. |
insert | Creates a global PublicDelegatedPrefix in the specified project usingthe parameters that are included in the request. |
list | Lists the global PublicDelegatedPrefixes for a project. |
patch | Patches the specified global PublicDelegatedPrefix resource with thedata included in the request. This method supports PATCH semantics anduses JSON merge patch format and processing rules. |
Module: googleapis.compute.v1.healthChecks
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all HealthCheck resources, regional and global,available to the specified project. |
delete | Deletes the specified HealthCheck resource. |
get | Returns the specified HealthCheck resource. |
insert | Creates a HealthCheck resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of HealthCheck resources available to the specifiedproject. |
patch | Updates a HealthCheck resource in the specified project using the dataincluded in the request. This method supports PATCH semantics and usesthe JSON merge patch format and processing rules. |
update | Updates a HealthCheck resource in the specified project using the dataincluded in the request. |
Module: googleapis.compute.v1.httpHealthChecks
| Functions | |
|---|---|
delete | Deletes the specified HttpHealthCheck resource. |
get | Returns the specified HttpHealthCheck resource. |
insert | Creates a HttpHealthCheck resource in the specified project using thedata included in the request. |
list | Retrieves the list of HttpHealthCheck resources available to thespecified project. |
patch | Updates a HttpHealthCheck resource in the specified project using thedata included in the request. This method supports PATCH semantics anduses the JSON merge patch format and processing rules. |
update | Updates a HttpHealthCheck resource in the specified project using thedata included in the request. |
Module: googleapis.compute.v1.httpsHealthChecks
| Functions | |
|---|---|
delete | Deletes the specified HttpsHealthCheck resource. |
get | Returns the specified HttpsHealthCheck resource. |
insert | Creates a HttpsHealthCheck resource in the specified project using thedata included in the request. |
list | Retrieves the list of HttpsHealthCheck resources available to thespecified project. |
patch | Updates a HttpsHealthCheck resource in the specified project using thedata included in the request. This method supports PATCH semantics anduses the JSON merge patch format and processing rules. |
update | Updates a HttpsHealthCheck resource in the specified project using thedata included in the request. |
Module: googleapis.compute.v1.imageFamilyViews
| Functions | |
|---|---|
get | Returns the latest image that is part of an image family, is notdeprecated and is rolled out in the specified zone. |
Module: googleapis.compute.v1.images
| Functions | |
|---|---|
delete | Deletes the specified image. |
deprecate | Sets the deprecation status of an image. If an empty request body isgiven, clears the deprecation status instead. |
get | Returns the specified image. |
getFromFamily | Returns the latest image that is part of an image family and is notdeprecated. For more information on image families, see Public imagefamilies documentation. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates an image in the specified project using the data included in therequest. |
list | Retrieves the list of custom images available to the specified project.Custom images are images you create that belong to your project. Thismethod does not get any images that belong to other projects, includingpublicly-available images, like Debian 8. If you want to get a list ofpublicly-available images, use this method to make a request to therespective image project, such as debian-cloud or windows-cloud. |
patch | Patches the specified image with the data included in the request. Onlythe following fields can be modified: family, description, deprecationstatus. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on an image. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.instanceGroupManagers
| Functions | |
|---|---|
abandonInstances | Flags the specified instances to be removed from the managed instancegroup. Abandoning an instance does not delete the instance, but it doesremove the instance from any target pools that are applied by themanaged instance group. This method reduces the targetSize of themanaged instance group by the number of instances that you abandon. Thisoperation is marked as DONE when the action is scheduled even if theinstances have not yet been removed from the group. You must separatelyverify the status of the abandoning action with the listmanagedinstancesmethod. If the group is part of a backend service that has enabledconnection draining, it can take up to 60 seconds after the connectiondraining duration has elapsed before the VM instance is removed ordeleted. You can specify a maximum of 1000 instances with this methodper request. |
aggregatedList | Retrieves the list of managed instance groups and groups them by zone. |
applyUpdatesToInstances | Applies changes to selected instances on the managed instance group.This method can be used to apply new overrides and/or new versions. |
createInstances | Creates instances with per-instance configurations in this managedinstance group. Instances are created using the current instancetemplate. The create instances operation is marked DONE if thecreateInstances request is successful. The underlying actions takeadditional time. You must separately verify the status of the creatingor actions with the listmanagedinstances method. |
delete | Deletes the specified managed instance group and all of the instances inthat group. Note that the instance group must not belong to a backendservice. Read Deleting an instance group for more information. |
deleteInstances | Flags the specified instances in the managed instance group forimmediate deletion. The instances are also removed from any target poolsof which they were a member. This method reduces the targetSize of themanaged instance group by the number of instances that you delete. Thisoperation is marked as DONE when the action is scheduled even if theinstances are still being deleted. You must separately verify the statusof the deleting action with the listmanagedinstances method. If thegroup is part of a backend service that has enabled connection draining,it can take up to 60 seconds after the connection draining duration haselapsed before the VM instance is removed or deleted. You can specify amaximum of 1000 instances with this method per request. |
deletePerInstanceConfigs | Deletes selected per-instance configurations for the managed instancegroup. |
get | Returns all of the details about the specified managed instance group. |
insert | Creates a managed instance group using the information that you specifyin the request. After the group is created, instances in the group arecreated using the specified instance template. This operation is markedas DONE when the group is created even if the instances in the grouphave not yet been created. You must separately verify the status of theindividual instances with the listmanagedinstances method. A managedinstance group can have up to 1000 VM instances per group. Pleasecontact Cloud Support if you need an increase in this limit. |
list | Retrieves a list of managed instance groups that are contained withinthe specified project and zone. |
listErrors | Lists all errors thrown by actions on instances for a given managedinstance group. The filter and orderBy query parameters are notsupported. |
listManagedInstances | Lists all of the instances in the managed instance group. Each instancein the list has a currentAction, which indicates the action that themanaged instance group is performing on the instance. For example, ifthe group is still creating an instance, the currentAction is CREATING.If a previous action failed, the list displays the errors for thatfailed action. The orderBy query parameter is not supported. ThepageToken query parameter is supported only in the alpha and beta APIand only if the group'slistManagedInstancesResults field is set toPAGINATED. |
listPerInstanceConfigs | Lists all of the per-instance configurations defined for the managedinstance group. The orderBy query parameter is not supported. |
patch | Updates a managed instance group using the information that you specifyin the request. This operation is marked as DONE when the group ispatched even if the instances in the group are still in the process ofbeing patched. You must separately verify the status of the individualinstances with the listManagedInstances method. This method supportsPATCH semantics and uses the JSON merge patch format and processingrules. If you update your group to specify a new template or instanceconfiguration, it's possible that your intended specification for eachVM in the group is different from the current state of that VM. To learnhow to apply an updated configuration to the VMs in a MIG, see Updatinginstances in a MIG. |
patchPerInstanceConfigs | Inserts or patches per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
recreateInstances | Flags the specified VM instances in the managed instance group to beimmediately recreated. Each instance is recreated using the group'scurrent configuration. This operation is marked as DONE when the flag isset even if the instances have not yet been recreated. You mustseparately verify the status of each instance by checking itscurrentAction field; for more information, see Checking the status ofmanaged instances. If the group is part of a backend service that hasenabled connection draining, it can take up to 60 seconds after theconnection draining duration has elapsed before the VM instance isremoved or deleted. You can specify a maximum of 1000 instances withthis method per request. |
resize | Resizes the managed instance group. If you increase the size, the groupcreates new instances using the current instance template. If youdecrease the size, the group deletes instances. The resize operation ismarked DONE when the resize actions are scheduled even if the group hasnot yet added or deleted any instances. You must separately verify thestatus of the creating or deleting actions with the listmanagedinstancesmethod. When resizing down, the instance group arbitrarily chooses theorder in which VMs are deleted. The group takes into account some VMattributes when making the selection including: + The status of the VMinstance. + The health of the VM instance. + The instance templateversion the VM is based on. + For regional managed instance groups, thelocation of the VM instance. This list is subject to change. If thegroup is part of a backend service that has enabled connection draining,it can take up to 60 seconds after the connection draining duration haselapsed before the VM instance is removed or deleted. |
setInstanceTemplate | Specifies the instance template to use when creating new instances inthis group. The templates for existing instances in the group do notchange unless you run recreateInstances, run applyUpdatesToInstances, orset the group's updatePolicy.type to PROACTIVE. |
setTargetPools | Modifies the target pools to which all instances in this managedinstance group are assigned. The target pools automatically apply to allof the instances in the managed instance group. This operation is markedDONE when you make the request even if the instances have not yet beenadded to their target pools. The change might take some time to apply toall of the instances in the group depending on the size of the group. |
updatePerInstanceConfigs | Inserts or updates per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
Module: googleapis.compute.v1.instanceGroups
| Functions | |
|---|---|
addInstances | Adds a list of instances to the specified instance group. All of theinstances in the instance group must be in the same network/subnetwork.Read Adding instances for more information. |
aggregatedList | Retrieves the list of instance groups and sorts them by zone. |
delete | Deletes the specified instance group. The instances in the group are notdeleted. Note that instance group must not belong to a backend service.Read Deleting an instance group for more information. |
get | Returns the specified zonal instance group. Get a list of availablezonal instance groups by making a list() request. For managed instancegroups, use the instanceGroupManagers or regionInstanceGroupManagersmethods instead. |
insert | Creates an instance group in the specified project using the parametersthat are included in the request. |
list | Retrieves the list of zonal instance group resources contained withinthe specified zone. For managed instance groups, use theinstanceGroupManagers or regionInstanceGroupManagers methods instead. |
listInstances | Lists the instances in the specified instance group. The orderBy queryparameter is not supported. The filter query parameter is supported, butonly for expressions that useeq (equal) orne (not equal)operators. |
removeInstances | Removes one or more instances from the specified instance group, butdoes not delete those instances. If the group is part of a backendservice that has enabled connection draining, it can take up to 60seconds after the connection draining duration before the VM instance isremoved or deleted. |
setNamedPorts | Sets the named ports for the specified instance group. |
Module: googleapis.compute.v1.instanceTemplates
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all InstanceTemplates resources, regional andglobal, available to the specified project. |
delete | Deletes the specified instance template. Deleting an instance templateis permanent and cannot be undone. It is not possible to deletetemplates that are already in use by a managed instance group. |
get | Returns the specified instance template. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates an instance template in the specified project using the datathat is included in the request. If you are creating a new template toupdate an existing instance group, your new instance template must usethe same network or, if applicable, the same subnetwork as the originaltemplate. |
list | Retrieves a list of instance templates that are contained within thespecified project. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.instances
| Functions | |
|---|---|
addAccessConfig | Adds an access config to an instance's network interface. |
addResourcePolicies | Adds existing resource policies to an instance. You can only add onepolicy right now which will be applied to this instance for schedulinglive migrations. |
aggregatedList | Retrieves an aggregated list of all of the instances in your projectacross all regions and zones. The performance of this method degradeswhen a filter is specified on a project that has a very large number ofinstances. |
attachDisk | Attaches an existing Disk resource to an instance. You must first createthe disk before you can attach it. It is not possible to create andattach a disk at the same time. For more information, read Adding apersistent disk to your instance. |
bulkInsert | Creates multiple instances. Count specifies the number of instances tocreate. For more information, see About bulk creation of VMs. |
delete | Deletes the specified Instance resource. For more information, seeDeleting an instance. |
deleteAccessConfig | Deletes an access config from an instance's network interface. |
detachDisk | Detaches a disk from an instance. |
get | Returns the specified Instance resource. |
getEffectiveFirewalls | Returns effective firewalls applied to an interface of the instance. |
getGuestAttributes | Returns the specified guest attributes entry. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getScreenshot | Returns the screenshot from the specified instance. |
getSerialPortOutput | Returns the last 1 MB of serial port output from the specified instance. |
getShieldedInstanceIdentity | Returns the Shielded Instance Identity of an instance |
insert | Creates an instance resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of instances contained within the specified zone. |
listReferrers | Retrieves a list of resources that refer to the VM instance specified inthe request. For example, if the VM instance is part of a managed orunmanaged instance group, the referrers list includes the instancegroup. For more information, read Viewing referrers to VM instances. |
removeResourcePolicies | Removes resource policies from an instance. |
reset | Performs a reset on the instance. This is a hard reset. The VM does notdo a graceful shutdown. For more information, see Resetting an instance. |
resume | Resumes an instance that was suspended using the instances().suspendmethod. |
sendDiagnosticInterrupt | Sends diagnostic interrupt to the instance. |
setDeletionProtection | Sets deletion protection on the instance. |
setDiskAutoDelete | Sets the auto-delete flag for a disk attached to an instance. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets labels on an instance. To learn more about labels, read theLabeling Resources documentation. |
setMachineResources | Changes the number and/or type of accelerator for a stopped instance tothe values specified in the request. |
setMachineType | Changes the machine type for a stopped instance to the machine typespecified in the request. |
setMetadata | Sets metadata for the specified instance to the data included in therequest. |
setMinCpuPlatform | Changes the minimum CPU platform that this instance should use. Thismethod can only be called on a stopped instance. For more information,read Specifying a Minimum CPU Platform. |
setName | Sets name of an instance. |
setScheduling | Sets an instance's scheduling options. You can only call this method ona stopped instance, that is, a VM instance that is in aTERMINATEDstate. See Instance Life Cycle for more information on the possibleinstance states. For more information about setting scheduling optionsfor a VM, see Set VM host maintenance policy. |
setServiceAccount | Sets the service account on the instance. For more information, readChanging the service account and access scopes for an instance. |
setShieldedInstanceIntegrityPolicy | Sets the Shielded Instance integrity policy for an instance. You canonly use this method on a running instance. This method supports PATCHsemantics and uses the JSON merge patch format and processing rules. |
setTags | Sets network tags for the specified instance to the data included in therequest. |
simulateMaintenanceEvent | Simulates a host maintenance event on a VM. For more information, seeSimulate a host maintenance event. |
start | Starts an instance that was stopped using the instances().stop method.For more information, see Restart an instance. |
startWithEncryptionKey | Starts an instance that was stopped using the instances().stop method.For more information, see Restart an instance. |
stop | Stops a running instance, shutting it down cleanly, and allows you torestart the instance at a later time. Stopped instances do not incur VMusage charges while they are stopped. However, resources that the VM isusing, such as persistent disks and static IP addresses, will continueto be charged until they are deleted. For more information, see Stoppingan instance. |
suspend | This method suspends a running instance, saving its state to persistentstorage, and allows you to resume the instance at a later time.Suspended instances have no compute costs (cores or RAM), and incur onlystorage charges for the saved VM memory and localSSD data. Any chargedresources the virtual machine was using, such as persistent disks andstatic IP addresses, will continue to be charged while the instance issuspended. For more information, see Suspending and resuming aninstance. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Updates an instance only if the necessary resources are available. Thismethod can update only a specific set of instance properties. SeeUpdating a running instance for a list of updatable instance properties. |
updateAccessConfig | Updates the specified access config from an instance's network interfacewith the data included in the request. This method supports PATCHsemantics and uses the JSON merge patch format and processing rules. |
updateDisplayDevice | Updates the Display config for a VM instance. You can only use thismethod on a stopped VM instance. This method supports PATCH semanticsand uses the JSON merge patch format and processing rules. |
updateNetworkInterface | Updates an instance's network interface. This method can only update aninterface's alias IP range and attached network. See Modifying alias IPranges for an existing instance for instructions on changing alias IPranges. See Migrating a VM between networks for instructions onmigrating an interface. This method follows PATCH semantics. |
updateShieldedInstanceConfig | Updates the Shielded Instance config for an instance. You can only usethis method on a stopped instance. This method supports PATCH semanticsand uses the JSON merge patch format and processing rules. |
Module: googleapis.compute.v1.interconnectAttachments
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of interconnect attachments. |
delete | Deletes the specified interconnect attachment. |
get | Returns the specified interconnect attachment. |
insert | Creates an InterconnectAttachment in the specified project using thedata included in the request. |
list | Retrieves the list of interconnect attachments contained within thespecified region. |
patch | Updates the specified interconnect attachment with the data included inthe request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
setLabels | Sets the labels on an InterconnectAttachment. To learn more aboutlabels, read the Labeling Resources documentation. |
Module: googleapis.compute.v1.interconnectLocations
| Functions | |
|---|---|
get | Returns the details for the specified interconnect location. Gets a listof available interconnect locations by making a list() request. |
list | Retrieves the list of interconnect locations available to the specifiedproject. |
Module: googleapis.compute.v1.interconnectRemoteLocations
| Functions | |
|---|---|
get | Returns the details for the specified interconnect remote location. Getsa list of available interconnect remote locations by making a list()request. |
list | Retrieves the list of interconnect remote locations available to thespecified project. |
Module: googleapis.compute.v1.interconnects
| Functions | |
|---|---|
delete | Deletes the specified Interconnect. |
get | Returns the specified Interconnect. Get a list of availableInterconnects by making a list() request. |
getDiagnostics | Returns the interconnectDiagnostics for the specified Interconnect. |
insert | Creates an Interconnect in the specified project using the data includedin the request. |
list | Retrieves the list of Interconnects available to the specified project. |
patch | Updates the specified Interconnect with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
setLabels | Sets the labels on an Interconnect. To learn more about labels, read theLabeling Resources documentation. |
Module: googleapis.compute.v1.licenseCodes
| Functions | |
|---|---|
get | Return a specified license code. License codes are mirrored across allprojects that have permissions to read the License Code.Caution Thisresource is intended for use only by third-party partners who arecreating Cloud Marketplace images. |
testIamPermissions | Returns permissions that a caller has on the specified resource.Caution This resource is intended for use only by third-party partnerswho are creating Cloud Marketplace images. |
Module: googleapis.compute.v1.licenses
| Functions | |
|---|---|
delete | Deletes the specified license.Caution This resource is intended foruse only by third-party partners who are creating Cloud Marketplaceimages. |
get | Returns the specified License resource.Caution This resource isintended for use only by third-party partners who are creating CloudMarketplace images. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists.Caution This resource is intended for useonly by third-party partners who are creating Cloud Marketplace images. |
insert | Create a License resource in the specified project.Caution Thisresource is intended for use only by third-party partners who arecreating Cloud Marketplace images. |
list | Retrieves the list of licenses available in the specified project. Thismethod does not get any licenses that belong to other projects,including licenses attached to publicly-available images, like Debian 9.If you want to get a list of publicly-available licenses, use thismethod to make a request to the respective image project, such asdebian-cloud or windows-cloud.Caution This resource is intended foruse only by third-party partners who are creating Cloud Marketplaceimages. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy.Caution This resource is intended for use only bythird-party partners who are creating Cloud Marketplace images. |
testIamPermissions | Returns permissions that a caller has on the specified resource.Caution This resource is intended for use only by third-party partnerswho are creating Cloud Marketplace images. |
Module: googleapis.compute.v1.machineImages
| Functions | |
|---|---|
delete | Deletes the specified machine image. Deleting a machine image ispermanent and cannot be undone. |
get | Returns the specified machine image. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a machine image in the specified project using the data that isincluded in the request. If you are creating a new machine image toupdate an existing instance, your new machine image should use the samenetwork or, if applicable, the same subnetwork as the original instance. |
list | Retrieves a list of machine images that are contained within thespecified project. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.machineTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of machine types. |
get | Returns the specified machine type. |
list | Retrieves a list of machine types available to the specified project. |
Module: googleapis.compute.v1.networkAttachments
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all NetworkAttachment resources, regional andglobal, available to the specified project. |
delete | Deletes the specified NetworkAttachment in the given scope |
get | Returns the specified NetworkAttachment resource in the given scope. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a NetworkAttachment in the specified project in the given scopeusing the parameters that are included in the request. |
list | Lists the NetworkAttachments for a project in the given scope. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.networkEdgeSecurityServices
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all NetworkEdgeSecurityService resources availableto the specified project. |
delete | Deletes the specified service. |
get | Gets a specified NetworkEdgeSecurityService. |
insert | Creates a new service in the specified project using the data includedin the request. |
patch | Patches the specified policy with the data included in the request. |
Module: googleapis.compute.v1.networkEndpointGroups
| Functions | |
|---|---|
aggregatedList | Retrieves the list of network endpoint groups and sorts them by zone. |
attachNetworkEndpoints | Attach a list of network endpoints to the specified network endpointgroup. |
delete | Deletes the specified network endpoint group. The network endpoints inthe NEG and the VM instances they belong to are not terminated when theNEG is deleted. Note that the NEG cannot be deleted if there are backendservices referencing it. |
detachNetworkEndpoints | Detach a list of network endpoints from the specified network endpointgroup. |
get | Returns the specified network endpoint group. |
insert | Creates a network endpoint group in the specified project using theparameters that are included in the request. |
list | Retrieves the list of network endpoint groups that are located in thespecified project and zone. |
listNetworkEndpoints | Lists the network endpoints in the specified network endpoint group. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.networkFirewallPolicies
| Functions | |
|---|---|
addAssociation | Inserts an association for the specified firewall policy. |
addRule | Inserts a rule into a firewall policy. |
cloneRules | Copies rules to the specified firewall policy. |
delete | Deletes the specified policy. |
get | Returns the specified network firewall policy. |
getAssociation | Gets an association with the specified name. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getRule | Gets a rule of the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | Lists all the policies that have been configured for the specifiedproject. |
patch | Patches the specified policy with the data included in the request. |
patchRule | Patches a rule of the specified priority. |
removeAssociation | Removes an association for the specified firewall policy. |
removeRule | Deletes a rule of the specified priority. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.networks
| Functions | |
|---|---|
addPeering | Adds a peering to the specified network. |
delete | Deletes the specified network. |
get | Returns the specified network. |
getEffectiveFirewalls | Returns the effective firewalls on a given network. |
insert | Creates a network in the specified project using the data included inthe request. |
list | Retrieves the list of networks available to the specified project. |
listPeeringRoutes | Lists the peering routes exchanged over peering connection. |
patch | Patches the specified network with the data included in the request.Only the following fields can be modified: routingConfig.routingMode. |
removePeering | Removes a peering from the specified network. |
switchToCustomMode | Switches the network mode from auto subnet mode to custom subnet mode. |
updatePeering | Updates the specified network peering with the data included in therequest. You can only modify the NetworkPeering.export_custom_routesfield and the NetworkPeering.import_custom_routes field. |
Module: googleapis.compute.v1.nodeGroups
| Functions | |
|---|---|
addNodes | Adds specified number of nodes to the node group. |
aggregatedList | Retrieves an aggregated list of node groups. Note: usenodeGroups.listNodes for more details about each group. |
delete | Deletes the specified NodeGroup resource. |
deleteNodes | Deletes specified nodes from the node group. |
get | Returns the specified NodeGroup. Get a list of available NodeGroups bymaking a list() request. Note: the "nodes" field should not be used.Use nodeGroups.listNodes instead. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a NodeGroup resource in the specified project using the dataincluded in the request. |
list | Retrieves a list of node groups available to the specified project.Note: use nodeGroups.listNodes for more details about each group. |
listNodes | Lists nodes in the node group. |
patch | Updates the specified node group. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setNodeTemplate | Updates the node template of the node group. |
simulateMaintenanceEvent | Simulates maintenance event on specified nodes from the node group. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.nodeTemplates
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of node templates. |
delete | Deletes the specified NodeTemplate resource. |
get | Returns the specified node template. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a NodeTemplate resource in the specified project using the dataincluded in the request. |
list | Retrieves a list of node templates available to the specified project. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.nodeTypes
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of node types. |
get | Returns the specified node type. |
list | Retrieves a list of node types available to the specified project. |
Module: googleapis.compute.v1.packetMirrorings
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of packetMirrorings. |
delete | Deletes the specified PacketMirroring resource. |
get | Returns the specified PacketMirroring resource. |
insert | Creates a PacketMirroring resource in the specified project and regionusing the data included in the request. |
list | Retrieves a list of PacketMirroring resources available to the specifiedproject and region. |
patch | Patches the specified PacketMirroring resource with the data included inthe request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.projects
| Functions | |
|---|---|
disableXpnHost | Disable this project as a shared VPC host project. |
disableXpnResource | Disable a service resource (also known as service project) associatedwith this host project. |
enableXpnHost | Enable this project as a shared VPC host project. |
enableXpnResource | Enable service resource (a.k.a service project) for a host project, sothat subnets in the host project can be used by instances in the serviceproject. |
get | Returns the specified Project resource. To decrease latency for thismethod, you can optionally omit any unneeded information from theresponse by using a field mask. This practice is especially recommendedfor unused quota information (thequotas field). To exclude one ormore fields, set your request'sfields query parameter to only includethe fields you need. For example, to only include theid andselfLink fields, add the query parameter?fields=id,selfLink to yourrequest. |
getXpnHost | Gets the shared VPC host project that this project links to. May beempty if no link exists. |
getXpnResources | Gets service resources (a.k.a service project) associated with this hostproject. |
listXpnHosts | Lists all shared VPC host projects visible to the user in anorganization. |
moveDisk | Moves a persistent disk from one zone to another. |
moveInstance | Moves an instance and its attached persistent disks from one zone toanother.Note: Moving VMs or disks by using this method might causeunexpected behavior. For more information, see theknownissue.[Deprecated] This method is deprecated. Seemoving instance acrosszones instead. |
setCommonInstanceMetadata | Sets metadata common to all instances within the specified project usingthe data included in the request. |
setDefaultNetworkTier | Sets the default network tier of the project. The default network tieris used when an address/forwardingRule/instance is created withoutspecifying the network tier field. |
setUsageExportBucket | Enables the usage export feature and sets the usage export bucket wherereports are stored. If you provide an empty request body using thismethod, the usage export feature will be disabled. |
Module: googleapis.compute.v1.publicAdvertisedPrefixes
| Functions | |
|---|---|
delete | Deletes the specified PublicAdvertisedPrefix |
get | Returns the specified PublicAdvertisedPrefix resource. |
insert | Creates a PublicAdvertisedPrefix in the specified project using theparameters that are included in the request. |
list | Lists the PublicAdvertisedPrefixes for a project. |
patch | Patches the specified Router resource with the data included in therequest. This method supports PATCH semantics and uses JSON merge patchformat and processing rules. |
Module: googleapis.compute.v1.publicDelegatedPrefixes
| Functions | |
|---|---|
aggregatedList | Lists all PublicDelegatedPrefix resources owned by the specific projectacross all scopes. |
delete | Deletes the specified PublicDelegatedPrefix in the given region. |
get | Returns the specified PublicDelegatedPrefix resource in the givenregion. |
insert | Creates a PublicDelegatedPrefix in the specified project in the givenregion using the parameters that are included in the request. |
list | Lists the PublicDelegatedPrefixes for a project in the given region. |
patch | Patches the specified PublicDelegatedPrefix resource with the dataincluded in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules. |
Module: googleapis.compute.v1.regionAutoscalers
| Functions | |
|---|---|
delete | Deletes the specified autoscaler. |
get | Returns the specified autoscaler. |
insert | Creates an autoscaler in the specified project using the data includedin the request. |
list | Retrieves a list of autoscalers contained within the specified region. |
patch | Updates an autoscaler in the specified project using the data includedin the request. This method supports PATCH semantics and uses the JSONmerge patch format and processing rules. |
update | Updates an autoscaler in the specified project using the data includedin the request. |
Module: googleapis.compute.v1.regionBackendServices
| Functions | |
|---|---|
delete | Deletes the specified regional BackendService resource. |
get | Returns the specified regional BackendService resource. |
getHealth | Gets the most recent health check results for this regionalBackendService. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a regional BackendService resource in the specified projectusing the data included in the request. For more information, seeBackend services overview. |
list | Retrieves the list of regional BackendService resources available to thespecified project in the given region. |
patch | Updates the specified regional BackendService resource with the dataincluded in the request. For more information, see Understanding backendservices This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
update | Updates the specified regional BackendService resource with the dataincluded in the request. For more information, see Backend servicesoverview . |
Module: googleapis.compute.v1.regionCommitments
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of commitments by region. |
get | Returns the specified commitment resource. |
insert | Creates a commitment in the specified project using the data included inthe request. |
list | Retrieves a list of commitments contained within the specified region. |
update | Updates the specified commitment with the data included in the request.Update is performed only on selected fields included as part ofupdate-mask. Only the following fields can be modified: auto_renew. |
Module: googleapis.compute.v1.regionDiskTypes
| Functions | |
|---|---|
get | Returns the specified regional disk type. |
list | Retrieves a list of regional disk types available to the specifiedproject. |
Module: googleapis.compute.v1.regionDisks
| Functions | |
|---|---|
addResourcePolicies | Adds existing resource policies to a regional disk. You can only add onepolicy which will be applied to this disk for scheduling snapshotcreation. |
bulkInsert | Bulk create a set of disks. |
createSnapshot | Creates a snapshot of a specified persistent disk. For regular snapshotcreation, consider using snapshots.insert instead, as that methodsupports more features, such as creating snapshots in a projectdifferent from the source disk project. |
delete | Deletes the specified regional persistent disk. Deleting a regional diskremoves all the replicas of its data permanently and is irreversible.However, deleting a disk does not delete any snapshots previously madefrom the disk. You must separately delete snapshots. |
get | Returns a specified regional persistent disk. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a persistent regional disk in the specified project using thedata included in the request. |
list | Retrieves the list of persistent disks contained within the specifiedregion. |
removeResourcePolicies | Removes resource policies from a regional disk. |
resize | Resizes the specified regional persistent disk. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on the target regional disk. |
startAsyncReplication | Starts asynchronous replication. Must be invoked on the primary disk. |
stopAsyncReplication | Stops asynchronous replication. Can be invoked either on the primary oron the secondary disk. |
stopGroupAsyncReplication | Stops asynchronous replication for a consistency group of disks. Can beinvoked either in the primary or secondary scope. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Update the specified disk with the data included in the request. Updateis performed only on selected fields included as part of update-mask.Only the following fields can be modified: user_license. |
Module: googleapis.compute.v1.regionHealthCheckServices
| Functions | |
|---|---|
delete | Deletes the specified regional HealthCheckService. |
get | Returns the specified regional HealthCheckService resource. |
insert | Creates a regional HealthCheckService resource in the specified projectand region using the data included in the request. |
list | Lists all the HealthCheckService resources that have been configured forthe specified project in the given region. |
patch | Updates the specified regional HealthCheckService resource with the dataincluded in the request. This method supports PATCH semantics and usesthe JSON merge patch format and processing rules. |
Module: googleapis.compute.v1.regionHealthChecks
| Functions | |
|---|---|
delete | Deletes the specified HealthCheck resource. |
get | Returns the specified HealthCheck resource. |
insert | Creates a HealthCheck resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of HealthCheck resources available to the specifiedproject. |
patch | Updates a HealthCheck resource in the specified project using the dataincluded in the request. This method supports PATCH semantics and usesthe JSON merge patch format and processing rules. |
update | Updates a HealthCheck resource in the specified project using the dataincluded in the request. |
Module: googleapis.compute.v1.regionInstanceGroupManagers
| Functions | |
|---|---|
abandonInstances | Flags the specified instances to be immediately removed from the managedinstance group. Abandoning an instance does not delete the instance, butit does remove the instance from any target pools that are applied bythe managed instance group. This method reduces the targetSize of themanaged instance group by the number of instances that you abandon. Thisoperation is marked as DONE when the action is scheduled even if theinstances have not yet been removed from the group. You must separatelyverify the status of the abandoning action with the listmanagedinstancesmethod. If the group is part of a backend service that has enabledconnection draining, it can take up to 60 seconds after the connectiondraining duration has elapsed before the VM instance is removed ordeleted. You can specify a maximum of 1000 instances with this methodper request. |
applyUpdatesToInstances | Apply updates to selected instances the managed instance group. |
createInstances | Creates instances with per-instance configurations in this regionalmanaged instance group. Instances are created using the current instancetemplate. The create instances operation is marked DONE if thecreateInstances request is successful. The underlying actions takeadditional time. You must separately verify the status of the creatingor actions with the listmanagedinstances method. |
delete | Deletes the specified managed instance group and all of the instances inthat group. |
deleteInstances | Flags the specified instances in the managed instance group to beimmediately deleted. The instances are also removed from any targetpools of which they were a member. This method reduces the targetSize ofthe managed instance group by the number of instances that you delete.The deleteInstances operation is marked DONE if the deleteInstancesrequest is successful. The underlying actions take additional time. Youmust separately verify the status of the deleting action with thelistmanagedinstances method. If the group is part of a backend servicethat has enabled connection draining, it can take up to 60 seconds afterthe connection draining duration has elapsed before the VM instance isremoved or deleted. You can specify a maximum of 1000 instances withthis method per request. |
deletePerInstanceConfigs | Deletes selected per-instance configurations for the managed instancegroup. |
get | Returns all of the details about the specified managed instance group. |
insert | Creates a managed instance group using the information that you specifyin the request. After the group is created, instances in the group arecreated using the specified instance template. This operation is markedas DONE when the group is created even if the instances in the grouphave not yet been created. You must separately verify the status of theindividual instances with the listmanagedinstances method. A regionalmanaged instance group can contain up to 2000 instances. |
list | Retrieves the list of managed instance groups that are contained withinthe specified region. |
listErrors | Lists all errors thrown by actions on instances for a given regionalmanaged instance group. The filter and orderBy query parameters are notsupported. |
listManagedInstances | Lists the instances in the managed instance group and instances that arescheduled to be created. The list includes any current actions that thegroup has scheduled for its instances. The orderBy query parameter isnot supported. ThepageToken query parameter is supported only in thealpha and beta API and only if the group'slistManagedInstancesResultsfield is set toPAGINATED. |
listPerInstanceConfigs | Lists all of the per-instance configurations defined for the managedinstance group. The orderBy query parameter is not supported. |
patch | Updates a managed instance group using the information that you specifyin the request. This operation is marked as DONE when the group ispatched even if the instances in the group are still in the process ofbeing patched. You must separately verify the status of the individualinstances with the listmanagedinstances method. This method supportsPATCH semantics and uses the JSON merge patch format and processingrules. If you update your group to specify a new template or instanceconfiguration, it's possible that your intended specification for eachVM in the group is different from the current state of that VM. To learnhow to apply an updated configuration to the VMs in a MIG, see Updatinginstances in a MIG. |
patchPerInstanceConfigs | Inserts or patches per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
recreateInstances | Flags the specified VM instances in the managed instance group to beimmediately recreated. Each instance is recreated using the group'scurrent configuration. This operation is marked as DONE when the flag isset even if the instances have not yet been recreated. You mustseparately verify the status of each instance by checking itscurrentAction field; for more information, see Checking the status ofmanaged instances. If the group is part of a backend service that hasenabled connection draining, it can take up to 60 seconds after theconnection draining duration has elapsed before the VM instance isremoved or deleted. You can specify a maximum of 1000 instances withthis method per request. |
resize | Changes the intended size of the managed instance group. If you increasethe size, the group creates new instances using the current instancetemplate. If you decrease the size, the group deletes one or moreinstances. The resize operation is marked DONE if the resize request issuccessful. The underlying actions take additional time. You mustseparately verify the status of the creating or deleting actions withthe listmanagedinstances method. If the group is part of a backendservice that has enabled connection draining, it can take up to 60seconds after the connection draining duration has elapsed before the VMinstance is removed or deleted. |
setInstanceTemplate | Sets the instance template to use when creating new instances orrecreating instances in this group. Existing instances are not affected. |
setTargetPools | Modifies the target pools to which all new instances in this group areassigned. Existing instances in the group are not affected. |
updatePerInstanceConfigs | Inserts or updates per-instance configurations for the managed instancegroup. perInstanceConfig.name serves as a key used to distinguishwhether to perform insert or patch. |
Module: googleapis.compute.v1.regionInstanceGroups
| Functions | |
|---|---|
get | Returns the specified instance group resource. |
list | Retrieves the list of instance group resources contained within thespecified region. |
listInstances | Lists the instances in the specified instance group and displaysinformation about the named ports. Depending on the specified options,this method can list all instances or only the instances that arerunning. The orderBy query parameter is not supported. |
setNamedPorts | Sets the named ports for the specified regional instance group. |
Module: googleapis.compute.v1.regionInstances
| Functions | |
|---|---|
bulkInsert | Creates multiple instances in a given region. Count specifies the numberof instances to create. |
Module: googleapis.compute.v1.regionNetworkEndpointGroups
| Functions | |
|---|---|
delete | Deletes the specified network endpoint group. Note that the NEG cannotbe deleted if it is configured as a backend of a backend service. |
get | Returns the specified network endpoint group. |
insert | Creates a network endpoint group in the specified project using theparameters that are included in the request. |
list | Retrieves the list of regional network endpoint groups available to thespecified project in the given region. |
Module: googleapis.compute.v1.regionNetworkFirewallPolicies
| Functions | |
|---|---|
addAssociation | Inserts an association for the specified network firewall policy. |
addRule | Inserts a rule into a network firewall policy. |
cloneRules | Copies rules to the specified network firewall policy. |
delete | Deletes the specified network firewall policy. |
get | Returns the specified network firewall policy. |
getAssociation | Gets an association with the specified name. |
getEffectiveFirewalls | Returns the effective firewalls on a given network. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
getRule | Gets a rule of the specified priority. |
insert | Creates a new network firewall policy in the specified project andregion. |
list | Lists all the network firewall policies that have been configured forthe specified project in the given region. |
patch | Patches the specified network firewall policy. |
patchRule | Patches a rule of the specified priority. |
removeAssociation | Removes an association for the specified network firewall policy. |
removeRule | Deletes a rule of the specified priority. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.regionNotificationEndpoints
| Functions | |
|---|---|
delete | Deletes the specified NotificationEndpoint in the given region |
get | Returns the specified NotificationEndpoint resource in the given region. |
insert | Create a NotificationEndpoint in the specified project in the givenregion using the parameters that are included in the request. |
list | Lists the NotificationEndpoints for a project in the given region. |
Module: googleapis.compute.v1.regionOperations
| Functions | |
|---|---|
delete | Deletes the specified region-specific Operations resource. |
get | Retrieves the specified region-specific Operations resource. |
list | Retrieves a list of Operation resources contained within the specifiedregion. |
wait | Waits for the specified Operation resource to return asDONE or forthe request to approach the 2 minute deadline, and retrieves thespecified Operation resource. This method differs from theGET methodin that it waits for no more than the default deadline (2 minutes) andthen returns the current state of the operation, which might beDONEor still in progress. This method is called on a best-effort basis.Specifically: - In uncommon cases, when the server is overloaded, therequest might return before the default deadline is reached, or mightreturn after zero seconds. - If the default deadline is reached, thereis no guarantee that the operation is actually done when the methodreturns. Be prepared to retry if the operation is notDONE. |
Module: googleapis.compute.v1.regionSecurityPolicies
| Functions | |
|---|---|
delete | Deletes the specified policy. |
get | List all of the ordered rules present in a single specified policy. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | List all the policies that have been configured for the specifiedproject and region. |
patch | Patches the specified policy with the data included in the request. Toclear fields in the policy, leave the fields empty and specify them inthe updateMask. This cannot be used to be update the rules in thepolicy. Please use the per rule methods like addRule, patchRule, andremoveRule instead. |
Module: googleapis.compute.v1.regionSslCertificates
| Functions | |
|---|---|
delete | Deletes the specified SslCertificate resource in the region. |
get | Returns the specified SslCertificate resource in the specified region.Get a list of available SSL certificates by making a list() request. |
insert | Creates a SslCertificate resource in the specified project and regionusing the data included in the request |
list | Retrieves the list of SslCertificate resources available to thespecified project in the specified region. |
Module: googleapis.compute.v1.regionSslPolicies
| Functions | |
|---|---|
delete | Deletes the specified SSL policy. The SSL policy resource can be deletedonly if it is not in use by any TargetHttpsProxy or TargetSslProxyresources. |
get | Lists all of the ordered rules present in a single specified policy. |
insert | Creates a new policy in the specified project and region using the dataincluded in the request. |
list | Lists all the SSL policies that have been configured for the specifiedproject and region. |
listAvailableFeatures | Lists all features that can be specified in the SSL policy when usingcustom profile. |
patch | Patches the specified SSL policy with the data included in the request. |
Module: googleapis.compute.v1.regionTargetHttpProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetHttpProxy resource. |
get | Returns the specified TargetHttpProxy resource in the specified region. |
insert | Creates a TargetHttpProxy resource in the specified project and regionusing the data included in the request. |
list | Retrieves the list of TargetHttpProxy resources available to thespecified project in the specified region. |
setUrlMap | Changes the URL map for TargetHttpProxy. |
Module: googleapis.compute.v1.regionTargetHttpsProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetHttpsProxy resource. |
get | Returns the specified TargetHttpsProxy resource in the specified region. |
insert | Creates a TargetHttpsProxy resource in the specified project and regionusing the data included in the request. |
list | Retrieves the list of TargetHttpsProxy resources available to thespecified project in the specified region. |
patch | Patches the specified regional TargetHttpsProxy resource with the dataincluded in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules. |
setSslCertificates | Replaces SslCertificates for TargetHttpsProxy. |
setUrlMap | Changes the URL map for TargetHttpsProxy. |
Module: googleapis.compute.v1.regionTargetTcpProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetTcpProxy resource. |
get | Returns the specified TargetTcpProxy resource. |
insert | Creates a TargetTcpProxy resource in the specified project and regionusing the data included in the request. |
list | Retrieves a list of TargetTcpProxy resources available to the specifiedproject in a given region. |
Module: googleapis.compute.v1.regionUrlMaps
| Functions | |
|---|---|
delete | Deletes the specified UrlMap resource. |
get | Returns the specified UrlMap resource. |
insert | Creates a UrlMap resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of UrlMap resources available to the specifiedproject in the specified region. |
patch | Patches the specified UrlMap resource with the data included in therequest. This method supports PATCH semantics and uses JSON merge patchformat and processing rules. |
update | Updates the specified UrlMap resource with the data included in therequest. |
validate | Runs static validation for the UrlMap. In particular, the tests of theprovided UrlMap will be run. Calling this method does NOT create theUrlMap. |
Module: googleapis.compute.v1.regions
| Functions | |
|---|---|
get | Returns the specified Region resource. To decrease latency for thismethod, you can optionally omit any unneeded information from theresponse by using a field mask. This practice is especially recommendedfor unused quota information (thequotas field). To exclude one ormore fields, set your request'sfields query parameter to only includethe fields you need. For example, to only include theid andselfLink fields, add the query parameter?fields=id,selfLink to yourrequest. |
list | Retrieves the list of region resources available to the specifiedproject. To decrease latency for this method, you can optionally omitany unneeded information from the response by using a field mask. Thispractice is especially recommended for unused quota information (theitems.quotas field). To exclude one or more fields, set your request'sfields query parameter to only include the fields you need. Forexample, to only include theid andselfLink fields, add the queryparameter?fields=id,selfLink to your request. |
Module: googleapis.compute.v1.reservations
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of reservations. |
delete | Deletes the specified reservation. |
get | Retrieves information about the specified reservation. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a new reservation. For more information, read Reserving zonalresources. |
list | A list of all the reservations that have been configured for thespecified project in specified zone. |
resize | Resizes the reservation (applicable to standalone reservations only).For more information, read Modifying reservations. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
update | Update share settings of the reservation. |
Module: googleapis.compute.v1.resourcePolicies
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of resource policies. |
delete | Deletes the specified resource policy. |
get | Retrieves all information of the specified resource policy. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a new resource policy. |
list | A list all the resource policies that have been configured for thespecified project in specified region. |
patch | Modify the specified resource policy. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.routers
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of routers. |
delete | Deletes the specified Router resource. |
get | Returns the specified Router resource. |
getNatIpInfo | Retrieves runtime NAT IP information. |
getNatMappingInfo | Retrieves runtime Nat mapping information of VM endpoints. |
getRouterStatus | Retrieves runtime information of the specified router. |
insert | Creates a Router resource in the specified project and region using thedata included in the request. |
list | Retrieves a list of Router resources available to the specified project. |
patch | Patches the specified Router resource with the data included in therequest. This method supports PATCH semantics and uses JSON merge patchformat and processing rules. |
preview | Preview fields auto-generated during router create and updateoperations. Calling this method does NOT create or update the router. |
update | Updates the specified Router resource with the data included in therequest. This method conforms to PUT semantics, which requests that thestate of the target resource be created or replaced with the statedefined by the representation enclosed in the request message payload. |
Module: googleapis.compute.v1.routes
| Functions | |
|---|---|
delete | Deletes the specified Route resource. |
get | Returns the specified Route resource. |
insert | Creates a Route resource in the specified project using the dataincluded in the request. |
list | Retrieves the list of Route resources available to the specifiedproject. |
Module: googleapis.compute.v1.securityPolicies
| Functions | |
|---|---|
addRule | Inserts a rule into a security policy. |
aggregatedList | Retrieves the list of all SecurityPolicy resources, regional and global,available to the specified project. |
delete | Deletes the specified policy. |
get | List all of the ordered rules present in a single specified policy. |
getRule | Gets a rule at the specified priority. |
insert | Creates a new policy in the specified project using the data included inthe request. |
list | List all the policies that have been configured for the specifiedproject. |
listPreconfiguredExpressionSets | Gets the current list of preconfigured Web Application Firewall (WAF)expressions. |
patch | Patches the specified policy with the data included in the request. Toclear fields in the policy, leave the fields empty and specify them inthe updateMask. This cannot be used to be update the rules in thepolicy. Please use the per rule methods like addRule, patchRule, andremoveRule instead. |
patchRule | Patches a rule at the specified priority. To clear fields in the rule,leave the fields empty and specify them in the updateMask. |
removeRule | Deletes a rule at the specified priority. |
setLabels | Sets the labels on a security policy. To learn more about labels, readthe Labeling Resources documentation. |
Module: googleapis.compute.v1.serviceAttachments
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all ServiceAttachment resources, regional andglobal, available to the specified project. |
delete | Deletes the specified ServiceAttachment in the given scope |
get | Returns the specified ServiceAttachment resource in the given scope. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a ServiceAttachment in the specified project in the given scopeusing the parameters that are included in the request. |
list | Lists the ServiceAttachments for a project in the given scope. |
patch | Patches the specified ServiceAttachment resource with the data includedin the request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.snapshots
| Functions | |
|---|---|
delete | Deletes the specified Snapshot resource. Keep in mind that deleting asingle snapshot might not necessarily delete all the data on thatsnapshot. If any data on the snapshot that is marked for deletion isneeded for subsequent snapshots, the data will be moved to the nextcorresponding snapshot. For more information, see Deleting snapshots. |
get | Returns the specified Snapshot resource. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a snapshot in the specified project using the data included inthe request. For regular snapshot creation, consider using this methodinstead of disks.createSnapshot, as this method supports more features,such as creating snapshots in a project different from the source diskproject. |
list | Retrieves the list of Snapshot resources contained within the specifiedproject. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setLabels | Sets the labels on a snapshot. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.sslCertificates
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all SslCertificate resources, regional and global,available to the specified project. |
delete | Deletes the specified SslCertificate resource. |
get | Returns the specified SslCertificate resource. |
insert | Creates a SslCertificate resource in the specified project using thedata included in the request. |
list | Retrieves the list of SslCertificate resources available to thespecified project. |
Module: googleapis.compute.v1.sslPolicies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all SslPolicy resources, regional and global,available to the specified project. |
delete | Deletes the specified SSL policy. The SSL policy resource can be deletedonly if it is not in use by any TargetHttpsProxy or TargetSslProxyresources. |
get | Lists all of the ordered rules present in a single specified policy. |
insert | Returns the specified SSL policy resource. |
list | Lists all the SSL policies that have been configured for the specifiedproject. |
listAvailableFeatures | Lists all features that can be specified in the SSL policy when usingcustom profile. |
patch | Patches the specified SSL policy with the data included in the request. |
Module: googleapis.compute.v1.subnetworks
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of subnetworks. |
delete | Deletes the specified subnetwork. |
expandIpCidrRange | Expands the IP CIDR range of the subnetwork to a specified value. |
get | Returns the specified subnetwork. |
getIamPolicy | Gets the access control policy for a resource. May be empty if no suchpolicy or resource exists. |
insert | Creates a subnetwork in the specified project using the data included inthe request. |
list | Retrieves a list of subnetworks available to the specified project. |
listUsable | Retrieves an aggregated list of all usable subnetworks in the project. |
patch | Patches the specified subnetwork with the data included in the request.Only certain fields can be updated with a patch request as indicated inthe field descriptions. You must specify the current fingerprint of thesubnetwork resource being patched. |
setIamPolicy | Sets the access control policy on the specified resource. Replaces anyexisting policy. |
setPrivateIpGoogleAccess | Set whether VMs in this subnet can access Google services withoutassigning external IP addresses through Private Google Access. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.targetGrpcProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetGrpcProxy in the given scope |
get | Returns the specified TargetGrpcProxy resource in the given scope. |
insert | Creates a TargetGrpcProxy in the specified project in the given scopeusing the parameters that are included in the request. |
list | Lists the TargetGrpcProxies for a project in the given scope. |
patch | Patches the specified TargetGrpcProxy resource with the data included inthe request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
Module: googleapis.compute.v1.targetHttpProxies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all TargetHttpProxy resources, regional andglobal, available to the specified project. |
delete | Deletes the specified TargetHttpProxy resource. |
get | Returns the specified TargetHttpProxy resource. |
insert | Creates a TargetHttpProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetHttpProxy resources available to thespecified project. |
patch | Patches the specified TargetHttpProxy resource with the data included inthe request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
setUrlMap | Changes the URL map for TargetHttpProxy. |
Module: googleapis.compute.v1.targetHttpsProxies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all TargetHttpsProxy resources, regional andglobal, available to the specified project. |
delete | Deletes the specified TargetHttpsProxy resource. |
get | Returns the specified TargetHttpsProxy resource. |
insert | Creates a TargetHttpsProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetHttpsProxy resources available to thespecified project. |
patch | Patches the specified TargetHttpsProxy resource with the data includedin the request. This method supports PATCH semantics and uses JSON mergepatch format and processing rules. |
setCertificateMap | Changes the Certificate Map for TargetHttpsProxy. |
setQuicOverride | Sets the QUIC override policy for TargetHttpsProxy. |
setSslCertificates | Replaces SslCertificates for TargetHttpsProxy. |
setSslPolicy | Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies theserver-side support for SSL features. This affects connections betweenclients and the HTTPS proxy load balancer. They do not affect theconnection between the load balancer and the backends. |
setUrlMap | Changes the URL map for TargetHttpsProxy. |
Module: googleapis.compute.v1.targetInstances
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of target instances. |
delete | Deletes the specified TargetInstance resource. |
get | Returns the specified TargetInstance resource. |
insert | Creates a TargetInstance resource in the specified project and zoneusing the data included in the request. |
list | Retrieves a list of TargetInstance resources available to the specifiedproject and zone. |
Module: googleapis.compute.v1.targetPools
| Functions | |
|---|---|
addHealthCheck | Adds health check URLs to a target pool. |
addInstance | Adds an instance to a target pool. |
aggregatedList | Retrieves an aggregated list of target pools. |
delete | Deletes the specified target pool. |
get | Returns the specified target pool. |
getHealth | Gets the most recent health check results for each IP for the instancethat is referenced by the given target pool. |
insert | Creates a target pool in the specified project and region using the dataincluded in the request. |
list | Retrieves a list of target pools available to the specified project andregion. |
removeHealthCheck | Removes health check URL from a target pool. |
removeInstance | Removes instance URL from a target pool. |
setBackup | Changes a backup target pool's configurations. |
Module: googleapis.compute.v1.targetSslProxies
| Functions | |
|---|---|
delete | Deletes the specified TargetSslProxy resource. |
get | Returns the specified TargetSslProxy resource. |
insert | Creates a TargetSslProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetSslProxy resources available to thespecified project. |
setBackendService | Changes the BackendService for TargetSslProxy. |
setCertificateMap | Changes the Certificate Map for TargetSslProxy. |
setProxyHeader | Changes the ProxyHeaderType for TargetSslProxy. |
setSslCertificates | Changes SslCertificates for TargetSslProxy. |
setSslPolicy | Sets the SSL policy for TargetSslProxy. The SSL policy specifies theserver-side support for SSL features. This affects connections betweenclients and the SSL proxy load balancer. They do not affect theconnection between the load balancer and the backends. |
Module: googleapis.compute.v1.targetTcpProxies
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all TargetTcpProxy resources, regional and global,available to the specified project. |
delete | Deletes the specified TargetTcpProxy resource. |
get | Returns the specified TargetTcpProxy resource. |
insert | Creates a TargetTcpProxy resource in the specified project using thedata included in the request. |
list | Retrieves the list of TargetTcpProxy resources available to thespecified project. |
setBackendService | Changes the BackendService for TargetTcpProxy. |
setProxyHeader | Changes the ProxyHeaderType for TargetTcpProxy. |
Module: googleapis.compute.v1.targetVpnGateways
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of target VPN gateways. |
delete | Deletes the specified target VPN gateway. |
get | Returns the specified target VPN gateway. |
insert | Creates a target VPN gateway in the specified project and region usingthe data included in the request. |
list | Retrieves a list of target VPN gateways available to the specifiedproject and region. |
setLabels | Sets the labels on a TargetVpnGateway. To learn more about labels, readthe Labeling Resources documentation. |
Module: googleapis.compute.v1.urlMaps
| Functions | |
|---|---|
aggregatedList | Retrieves the list of all UrlMap resources, regional and global,available to the specified project. |
delete | Deletes the specified UrlMap resource. |
get | Returns the specified UrlMap resource. |
insert | Creates a UrlMap resource in the specified project using the dataincluded in the request. |
invalidateCache | Initiates a cache invalidation operation, invalidating the specifiedpath, scoped to the specified UrlMap. For more information, seeInvalidating cached content. |
list | Retrieves the list of UrlMap resources available to the specifiedproject. |
patch | Patches the specified UrlMap resource with the data included in therequest. This method supports PATCH semantics and uses the JSON mergepatch format and processing rules. |
update | Updates the specified UrlMap resource with the data included in therequest. |
validate | Runs static validation for the UrlMap. In particular, the tests of theprovided UrlMap will be run. Calling this method does NOT create theUrlMap. |
Module: googleapis.compute.v1.vpnGateways
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of VPN gateways. |
delete | Deletes the specified VPN gateway. |
get | Returns the specified VPN gateway. |
getStatus | Returns the status for the specified VPN gateway. |
insert | Creates a VPN gateway in the specified project and region using the dataincluded in the request. |
list | Retrieves a list of VPN gateways available to the specified project andregion. |
setLabels | Sets the labels on a VpnGateway. To learn more about labels, read theLabeling Resources documentation. |
testIamPermissions | Returns permissions that a caller has on the specified resource. |
Module: googleapis.compute.v1.vpnTunnels
| Functions | |
|---|---|
aggregatedList | Retrieves an aggregated list of VPN tunnels. |
delete | Deletes the specified VpnTunnel resource. |
get | Returns the specified VpnTunnel resource. |
insert | Creates a VpnTunnel resource in the specified project and region usingthe data included in the request. |
list | Retrieves a list of VpnTunnel resources contained in the specifiedproject and region. |
setLabels | Sets the labels on a VpnTunnel. To learn more about labels, read theLabeling Resources documentation. |
Module: googleapis.compute.v1.zoneOperations
| Functions | |
|---|---|
delete | Deletes the specified zone-specific Operations resource. |
get | Retrieves the specified zone-specific Operations resource. |
list | Retrieves a list of Operation resources contained within the specifiedzone. |
wait | Waits for the specified Operation resource to return asDONE or forthe request to approach the 2 minute deadline, and retrieves thespecified Operation resource. This method waits for no more than the 2minutes and then returns the current state of the operation, which mightbeDONE or still in progress. This method is called on a best-effortbasis. Specifically: - In uncommon cases, when the server is overloaded,the request might return before the default deadline is reached, ormight return after zero seconds. - If the default deadline is reached,there is no guarantee that the operation is actually done when themethod returns. Be prepared to retry if the operation is notDONE. |
Module: googleapis.compute.v1.zones
| Functions | |
|---|---|
get | Returns the specified Zone resource. |
list | Retrieves the list of Zone resources available to the specified project. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-19 UTC.