happygapi.compute.instances — happygapi 0.4.2

Compute Engine API: instances. Creates and runs virtual machines on Google Cloud Platform. See: https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances

addAccessConfig$ clj

(addAccessConfig$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/addAccessConfig

Required parameters: instance, networkInterface, project, zone

Optional parameters: requestId

Body:

{:kind string, :name string, :natIP string, :networkTier string, :publicPtrDomainName string, :setPublicPtr boolean, :type string}

Adds an access config to an instance's network interface.

addResourcePolicies$ clj

(addResourcePolicies$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/addResourcePolicies

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:resourcePolicies [string]}

Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.

aggregatedList$ clj

(aggregatedList$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/aggregatedList

Required parameters: project

Optional parameters: filter, includeAllScopes, maxResults, orderBy, pageToken

Retrieves aggregated list of all of the instances in your project across all regions and zones.

attachDisk$ clj

(attachDisk$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/attachDisk

Required parameters: instance, project, zone

Optional parameters: forceAttach, requestId

Body:

{:interface string, :guestOsFeatures [{:type string}], :index integer, :deviceName string, :boot boolean, :mode string, :licenses [string], :type string, :source string, :autoDelete boolean, :kind string, :initializeParams {:description string, :labels {}, :sourceSnapshotEncryptionKey CustomerEncryptionKey, :resourcePolicies [string], :sourceImage string, :sourceImageEncryptionKey CustomerEncryptionKey, :sourceSnapshot string, :diskType string, :onUpdateAction string, :diskSizeGb string, :diskName string}, :diskSizeGb string, :diskEncryptionKey {:kmsKeyName string, :kmsKeyServiceAccount string, :rawKey string, :sha256 string}, :shieldedInstanceInitialState {:dbs [FileContentBuffer], :dbxs [FileContentBuffer], :keks [FileContentBuffer], :pk FileContentBuffer}}

Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

delete$ clj

(delete$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/delete

Required parameters: instance, project, zone

Optional parameters: requestId

Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

deleteAccessConfig$ clj

(deleteAccessConfig$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/deleteAccessConfig

Required parameters: accessConfig, instance, networkInterface, project, zone

Optional parameters: requestId

Deletes an access config from an instance's network interface.

detachDisk$ clj

(detachDisk$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/detachDisk

Required parameters: deviceName, instance, project, zone

Optional parameters: requestId

Detaches a disk from an instance.

get$ clj

(get$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/get

Required parameters: instance, project, zone

Optional parameters: none

Returns the specified Instance resource. Gets a list of available instances by making a list() request.

getGuestAttributes$ clj

(getGuestAttributes$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/getGuestAttributes

Required parameters: instance, project, zone

Optional parameters: queryPath, variableKey

Returns the specified guest attributes entry.

getIamPolicy$ clj

(getIamPolicy$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/getIamPolicy

Required parameters: project, resource, zone

Optional parameters: none

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

getSerialPortOutput$ clj

(getSerialPortOutput$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/getSerialPortOutput

Required parameters: instance, project, zone

Optional parameters: port, start

Returns the last 1 MB of serial port output from the specified instance.

getShieldedInstanceIdentity$ clj

(getShieldedInstanceIdentity$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/getShieldedInstanceIdentity

Required parameters: instance, project, zone

Optional parameters: none

Returns the Shielded Instance Identity of an instance

insert$ clj

(insert$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/insert

Required parameters: project, zone

Optional parameters: requestId, sourceInstanceTemplate

Body:

{:description string, :tags {:fingerprint string, :items [string]}, :labels {}, :startRestricted boolean, :shieldedInstanceConfig {:enableIntegrityMonitoring boolean, :enableSecureBoot boolean, :enableVtpm boolean}, :scheduling {:automaticRestart boolean, :nodeAffinities [SchedulingNodeAffinity], :onHostMaintenance string, :preemptible boolean}, :creationTimestamp string, :zone string, :name string, :canIpForward boolean, :statusMessage string, :guestAccelerators [{:acceleratorCount integer, :acceleratorType string}], :selfLink string, :hostname string, :machineType string, :displayDevice {:enableDisplay boolean}, :status string, :id string, :kind string, :disks [{:interface string, :guestOsFeatures [GuestOsFeature], :index integer, :deviceName string, :boot boolean, :mode string, :licenses [string], :type string, :source string, :autoDelete boolean, :kind string, :initializeParams AttachedDiskInitializeParams, :diskSizeGb string, :diskEncryptionKey CustomerEncryptionKey, :shieldedInstanceInitialState InitialStateConfig}], :cpuPlatform string, :reservationAffinity {:consumeReservationType string, :key string, :values [string]}, :networkInterfaces [{:accessConfigs [AccessConfig], :aliasIpRanges [AliasIpRange], :fingerprint string, :kind string, :name string, :network string, :networkIP string, :subnetwork string}], :deletionProtection boolean, :metadata {:fingerprint string, :items [{:key string, :value string}], :kind string}, :fingerprint string, :shieldedInstanceIntegrityPolicy {:updateAutoLearnPolicy boolean}, :labelFingerprint string, :serviceAccounts [{:email string, :scopes [string]}], :minCpuPlatform string}

Creates an instance resource in the specified project using the data included in the request.

list$ clj

(list$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/list

Required parameters: project, zone

Optional parameters: filter, maxResults, orderBy, pageToken

Retrieves the list of instances contained within the specified zone.

listReferrers$ clj

(listReferrers$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/listReferrers

Required parameters: instance, project, zone

Optional parameters: filter, maxResults, orderBy, pageToken

Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances.

removeResourcePolicies$ clj

(removeResourcePolicies$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/removeResourcePolicies

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:resourcePolicies [string]}

Removes resource policies from an instance.

reset$ clj

(reset$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/reset

Required parameters: instance, project, zone

Optional parameters: requestId

Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.

setDeletionProtection$ clj

(setDeletionProtection$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setDeletionProtection

Required parameters: project, resource, zone

Optional parameters: deletionProtection, requestId

Sets deletion protection on the instance.

setDiskAutoDelete$ clj

(setDiskAutoDelete$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setDiskAutoDelete

Required parameters: autoDelete, deviceName, instance, project, zone

Optional parameters: requestId

Sets the auto-delete flag for a disk attached to an instance.

setIamPolicy$ clj

(setIamPolicy$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setIamPolicy

Required parameters: project, resource, zone

Optional parameters: none

Body:

{:bindings [{:condition Expr, :members [string], :role string}], :etag string, :policy {:auditConfigs [AuditConfig], :bindings [Binding], :etag string, :iamOwned boolean, :rules [Rule], :version integer}}

Sets the access control policy on the specified resource. Replaces any existing policy.

setLabels$ clj

(setLabels$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setLabels

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:labelFingerprint string, :labels {}}

Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

setMachineResources$ clj

(setMachineResources$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setMachineResources

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:guestAccelerators [{:acceleratorCount integer, :acceleratorType string}]}

Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

setMachineType$ clj

(setMachineType$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setMachineType

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:machineType string}

Changes the machine type for a stopped instance to the machine type specified in the request.

setMetadata$ clj

(setMetadata$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setMetadata

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:fingerprint string, :items [{:key string, :value string}], :kind string}

Sets metadata for the specified instance to the data included in the request.

setMinCpuPlatform$ clj

(setMinCpuPlatform$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setMinCpuPlatform

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:minCpuPlatform string}

Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

setScheduling$ clj

(setScheduling$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setScheduling

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:automaticRestart boolean, :nodeAffinities [{:key string, :operator string, :values [string]}], :onHostMaintenance string, :preemptible boolean}

Sets an instance's scheduling options.

setServiceAccount$ clj

(setServiceAccount$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setServiceAccount

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:email string, :scopes [string]}

Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

setShieldedInstanceIntegrityPolicy$ clj

(setShieldedInstanceIntegrityPolicy$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setShieldedInstanceIntegrityPolicy

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:updateAutoLearnPolicy boolean}

Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

setTags$ clj

(setTags$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/setTags

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:fingerprint string, :items [string]}

Sets network tags for the specified instance to the data included in the request.

simulateMaintenanceEvent$ clj

(simulateMaintenanceEvent$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/simulateMaintenanceEvent

Required parameters: instance, project, zone

Optional parameters: none

Simulates a maintenance event on the instance.

start$ clj

(start$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/start

Required parameters: instance, project, zone

Optional parameters: requestId

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

startWithEncryptionKey$ clj

(startWithEncryptionKey$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/startWithEncryptionKey

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:disks [{:diskEncryptionKey CustomerEncryptionKey, :source string}]}

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

stop$ clj

(stop$ auth parameters)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/stop

Required parameters: instance, project, zone

Optional parameters: requestId

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

testIamPermissions$ clj

(testIamPermissions$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/testIamPermissions

Required parameters: project, resource, zone

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource.

update$ clj

(update$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/update

Required parameters: instance, project, zone

Optional parameters: minimalAction, mostDisruptiveAllowedAction, requestId

Body:

{:description string, :tags {:fingerprint string, :items [string]}, :labels {}, :startRestricted boolean, :shieldedInstanceConfig {:enableIntegrityMonitoring boolean, :enableSecureBoot boolean, :enableVtpm boolean}, :scheduling {:automaticRestart boolean, :nodeAffinities [SchedulingNodeAffinity], :onHostMaintenance string, :preemptible boolean}, :creationTimestamp string, :zone string, :name string, :canIpForward boolean, :statusMessage string, :guestAccelerators [{:acceleratorCount integer, :acceleratorType string}], :selfLink string, :hostname string, :machineType string, :displayDevice {:enableDisplay boolean}, :status string, :id string, :kind string, :disks [{:interface string, :guestOsFeatures [GuestOsFeature], :index integer, :deviceName string, :boot boolean, :mode string, :licenses [string], :type string, :source string, :autoDelete boolean, :kind string, :initializeParams AttachedDiskInitializeParams, :diskSizeGb string, :diskEncryptionKey CustomerEncryptionKey, :shieldedInstanceInitialState InitialStateConfig}], :cpuPlatform string, :reservationAffinity {:consumeReservationType string, :key string, :values [string]}, :networkInterfaces [{:accessConfigs [AccessConfig], :aliasIpRanges [AliasIpRange], :fingerprint string, :kind string, :name string, :network string, :networkIP string, :subnetwork string}], :deletionProtection boolean, :metadata {:fingerprint string, :items [{:key string, :value string}], :kind string}, :fingerprint string, :shieldedInstanceIntegrityPolicy {:updateAutoLearnPolicy boolean}, :labelFingerprint string, :serviceAccounts [{:email string, :scopes [string]}], :minCpuPlatform string}

Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

updateAccessConfig$ clj

(updateAccessConfig$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/updateAccessConfig

Required parameters: instance, networkInterface, project, zone

Optional parameters: requestId

Body:

{:kind string, :name string, :natIP string, :networkTier string, :publicPtrDomainName string, :setPublicPtr boolean, :type string}

Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

updateDisplayDevice$ clj

(updateDisplayDevice$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/updateDisplayDevice

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:enableDisplay boolean}

Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

updateNetworkInterface$ clj

(updateNetworkInterface$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/updateNetworkInterface

Required parameters: instance, networkInterface, project, zone

Optional parameters: requestId

Body:

{:accessConfigs [{:kind string, :name string, :natIP string, :networkTier string, :publicPtrDomainName string, :setPublicPtr boolean, :type string}], :aliasIpRanges [{:ipCidrRange string, :subnetworkRangeName string}], :fingerprint string, :kind string, :name string, :network string, :networkIP string, :subnetwork string}

Updates an instance's network interface. This method follows PATCH semantics.

updateShieldedInstanceConfig$ clj

(updateShieldedInstanceConfig$ auth parameters body)

https://developers.google.com/compute/docs/reference/latest/api/reference/rest/v1/instances/updateShieldedInstanceConfig

Required parameters: instance, project, zone

Optional parameters: requestId

Body:

{:enableIntegrityMonitoring boolean, :enableSecureBoot boolean, :enableVtpm boolean}

Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.