Liking cljdoc? Tell your friends :D

happygapi.compute.regionInstanceGroupManagers

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

Compute Engine API: regionInstanceGroupManagers.
Creates and runs virtual machines on Google Cloud Platform. 
See: https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers
raw docstring

abandonInstances$clj

(abandonInstances$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/abandonInstances

Required parameters: region, instanceGroupManager, project

Optional parameters: requestId

Body:

{:instances [string]}

Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/abandonInstances

Required parameters: region, instanceGroupManager, project

Optional parameters: requestId

Body: 

{:instances [string]}

Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
sourceraw docstring

applyUpdatesToInstances$clj

(applyUpdatesToInstances$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/applyUpdatesToInstances

Required parameters: region, instanceGroupManager, project

Optional parameters: none

Body:

{:allInstances boolean, :minimalAction string, :instances [string], :mostDisruptiveAllowedAction string}

Apply updates to selected instances the managed instance group.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/applyUpdatesToInstances

Required parameters: region, instanceGroupManager, project

Optional parameters: none

Body: 

{:allInstances boolean,
 :minimalAction string,
 :instances [string],
 :mostDisruptiveAllowedAction string}

Apply updates to selected instances the managed instance group.
sourceraw docstring

createInstances$clj

(createInstances$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/createInstances

Required parameters: region, project, instanceGroupManager

Optional parameters: requestId

Body:

{:instances [{:name string, :preservedState PreservedState, :status string, :fingerprint string}]}

Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/createInstances

Required parameters: region, project, instanceGroupManager

Optional parameters: requestId

Body: 

{:instances [{:name string,
              :preservedState PreservedState,
              :status string,
              :fingerprint string}]}

Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.
sourceraw docstring

delete$clj

(delete$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/delete

Required parameters: instanceGroupManager, project, region

Optional parameters: requestId

Deletes the specified managed instance group and all of the instances in that group.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/delete

Required parameters: instanceGroupManager, project, region

Optional parameters: requestId

Deletes the specified managed instance group and all of the instances in that group.
sourceraw docstring

deleteInstances$clj

(deleteInstances$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/deleteInstances

Required parameters: project, instanceGroupManager, region

Optional parameters: requestId

Body:

{:skipInstancesOnValidationError boolean, :instances [string]}

Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/deleteInstances

Required parameters: project, instanceGroupManager, region

Optional parameters: requestId

Body: 

{:skipInstancesOnValidationError boolean, :instances [string]}

Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
sourceraw docstring

deletePerInstanceConfigs$clj

(deletePerInstanceConfigs$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/deletePerInstanceConfigs

Required parameters: instanceGroupManager, project, region

Optional parameters: none

Body:

{:names [string]}

Deletes selected per-instance configs for the managed instance group.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/deletePerInstanceConfigs

Required parameters: instanceGroupManager, project, region

Optional parameters: none

Body: 

{:names [string]}

Deletes selected per-instance configs for the managed instance group.
sourceraw docstring

get$clj

(get$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/get

Required parameters: instanceGroupManager, region, project

Optional parameters: none

Returns all of the details about the specified managed instance group.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/get

Required parameters: instanceGroupManager, region, project

Optional parameters: none

Returns all of the details about the specified managed instance group.
sourceraw docstring

insert$clj

(insert$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/insert

Required parameters: region, project

Optional parameters: requestId

Body:

{:description string, :updatePolicy {:maxSurge FixedOrPercent, :maxUnavailable FixedOrPercent, :instanceRedistributionType string, :replacementMethod string, :type string, :minimalAction string}, :creationTimestamp string, :zone string, :name string, :selfLink string, :targetPools [string], :region string, :currentActions {:recreating integer, :restarting integer, :creating integer, :deleting integer, :refreshing integer, :abandoning integer, :verifying integer, :none integer, :creatingWithoutRetries integer}, :autoHealingPolicies [{:initialDelaySec integer, :healthCheck string}], :status {:stateful InstanceGroupManagerStatusStateful, :autoscaler string, :isStable boolean, :versionTarget InstanceGroupManagerStatusVersionTarget}, :instanceGroup string, :id string, :kind string, :distributionPolicy {:targetShape string, :zones [DistributionPolicyZoneConfiguration]}, :statefulPolicy {:preservedState StatefulPolicyPreservedState}, :baseInstanceName string, :versions [{:targetSize FixedOrPercent, :name string, :instanceTemplate string}], :targetSize integer, :instanceTemplate string, :fingerprint string, :namedPorts [{:name string, :port integer}]}

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/insert

Required parameters: region, project

Optional parameters: requestId

Body: 

{:description string,
 :updatePolicy {:maxSurge FixedOrPercent,
                :maxUnavailable FixedOrPercent,
                :instanceRedistributionType string,
                :replacementMethod string,
                :type string,
                :minimalAction string},
 :creationTimestamp string,
 :zone string,
 :name string,
 :selfLink string,
 :targetPools [string],
 :region string,
 :currentActions {:recreating integer,
                  :restarting integer,
                  :creating integer,
                  :deleting integer,
                  :refreshing integer,
                  :abandoning integer,
                  :verifying integer,
                  :none integer,
                  :creatingWithoutRetries integer},
 :autoHealingPolicies [{:initialDelaySec integer, :healthCheck string}],
 :status {:stateful InstanceGroupManagerStatusStateful,
          :autoscaler string,
          :isStable boolean,
          :versionTarget InstanceGroupManagerStatusVersionTarget},
 :instanceGroup string,
 :id string,
 :kind string,
 :distributionPolicy {:targetShape string,
                      :zones [DistributionPolicyZoneConfiguration]},
 :statefulPolicy {:preservedState StatefulPolicyPreservedState},
 :baseInstanceName string,
 :versions [{:targetSize FixedOrPercent,
             :name string,
             :instanceTemplate string}],
 :targetSize integer,
 :instanceTemplate string,
 :fingerprint string,
 :namedPorts [{:name string, :port integer}]}

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.
sourceraw docstring

list$clj

(list$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/list

Required parameters: project, region

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

Retrieves the list of managed instance groups that are contained within the specified region.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/list

Required parameters: project, region

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

Retrieves the list of managed instance groups that are contained within the specified region.
sourceraw docstring

listErrors$clj

(listErrors$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/listErrors

Required parameters: region, instanceGroupManager, project

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

Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/listErrors

Required parameters: region, instanceGroupManager, project

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

Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.
sourceraw docstring

listManagedInstances$clj

(listManagedInstances$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/listManagedInstances

Required parameters: instanceGroupManager, region, project

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

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/listManagedInstances

Required parameters: instanceGroupManager, region, project

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

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.
sourceraw docstring

listPerInstanceConfigs$clj

(listPerInstanceConfigs$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/listPerInstanceConfigs

Required parameters: project, instanceGroupManager, region

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

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/listPerInstanceConfigs

Required parameters: project, instanceGroupManager, region

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

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.
sourceraw docstring

patch$clj

(patch$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/patch

Required parameters: region, instanceGroupManager, project

Optional parameters: requestId

Body:

{:description string, :updatePolicy {:maxSurge FixedOrPercent, :maxUnavailable FixedOrPercent, :instanceRedistributionType string, :replacementMethod string, :type string, :minimalAction string}, :creationTimestamp string, :zone string, :name string, :selfLink string, :targetPools [string], :region string, :currentActions {:recreating integer, :restarting integer, :creating integer, :deleting integer, :refreshing integer, :abandoning integer, :verifying integer, :none integer, :creatingWithoutRetries integer}, :autoHealingPolicies [{:initialDelaySec integer, :healthCheck string}], :status {:stateful InstanceGroupManagerStatusStateful, :autoscaler string, :isStable boolean, :versionTarget InstanceGroupManagerStatusVersionTarget}, :instanceGroup string, :id string, :kind string, :distributionPolicy {:targetShape string, :zones [DistributionPolicyZoneConfiguration]}, :statefulPolicy {:preservedState StatefulPolicyPreservedState}, :baseInstanceName string, :versions [{:targetSize FixedOrPercent, :name string, :instanceTemplate string}], :targetSize integer, :instanceTemplate string, :fingerprint string, :namedPorts [{:name string, :port integer}]}

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/patch

Required parameters: region, instanceGroupManager, project

Optional parameters: requestId

Body: 

{:description string,
 :updatePolicy {:maxSurge FixedOrPercent,
                :maxUnavailable FixedOrPercent,
                :instanceRedistributionType string,
                :replacementMethod string,
                :type string,
                :minimalAction string},
 :creationTimestamp string,
 :zone string,
 :name string,
 :selfLink string,
 :targetPools [string],
 :region string,
 :currentActions {:recreating integer,
                  :restarting integer,
                  :creating integer,
                  :deleting integer,
                  :refreshing integer,
                  :abandoning integer,
                  :verifying integer,
                  :none integer,
                  :creatingWithoutRetries integer},
 :autoHealingPolicies [{:initialDelaySec integer, :healthCheck string}],
 :status {:stateful InstanceGroupManagerStatusStateful,
          :autoscaler string,
          :isStable boolean,
          :versionTarget InstanceGroupManagerStatusVersionTarget},
 :instanceGroup string,
 :id string,
 :kind string,
 :distributionPolicy {:targetShape string,
                      :zones [DistributionPolicyZoneConfiguration]},
 :statefulPolicy {:preservedState StatefulPolicyPreservedState},
 :baseInstanceName string,
 :versions [{:targetSize FixedOrPercent,
             :name string,
             :instanceTemplate string}],
 :targetSize integer,
 :instanceTemplate string,
 :fingerprint string,
 :namedPorts [{:name string, :port integer}]}

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
sourceraw docstring

patchPerInstanceConfigs$clj

(patchPerInstanceConfigs$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/patchPerInstanceConfigs

Required parameters: project, instanceGroupManager, region

Optional parameters: requestId

Body:

{:perInstanceConfigs [{:name string, :preservedState PreservedState, :status string, :fingerprint string}]}

Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/patchPerInstanceConfigs

Required parameters: project, instanceGroupManager, region

Optional parameters: requestId

Body: 

{:perInstanceConfigs [{:name string,
                       :preservedState PreservedState,
                       :status string,
                       :fingerprint string}]}

Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
sourceraw docstring

recreateInstances$clj

(recreateInstances$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/recreateInstances

Required parameters: region, instanceGroupManager, project

Optional parameters: requestId

Body:

{:instances [string]}

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/recreateInstances

Required parameters: region, instanceGroupManager, project

Optional parameters: requestId

Body: 

{:instances [string]}

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
sourceraw docstring

resize$clj

(resize$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/resize

Required parameters: instanceGroupManager, project, size, region

Optional parameters: requestId

Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/resize

Required parameters: instanceGroupManager, project, size, region

Optional parameters: requestId

Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
sourceraw docstring

setInstanceTemplate$clj

(setInstanceTemplate$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/setInstanceTemplate

Required parameters: instanceGroupManager, project, region

Optional parameters: requestId

Body:

{:instanceTemplate string}

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/setInstanceTemplate

Required parameters: instanceGroupManager, project, region

Optional parameters: requestId

Body: 

{:instanceTemplate string}

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
sourceraw docstring

setTargetPools$clj

(setTargetPools$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/setTargetPools

Required parameters: project, instanceGroupManager, region

Optional parameters: requestId

Body:

{:fingerprint string, :targetPools [string]}

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/setTargetPools

Required parameters: project, instanceGroupManager, region

Optional parameters: requestId

Body: 

{:fingerprint string, :targetPools [string]}

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
sourceraw docstring

updatePerInstanceConfigs$clj

(updatePerInstanceConfigs$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/updatePerInstanceConfigs

Required parameters: project, region, instanceGroupManager

Optional parameters: requestId

Body:

{:perInstanceConfigs [{:name string, :preservedState PreservedState, :status string, :fingerprint string}]}

Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

https://cloud.google.com/compute/api/reference/rest/v1/regionInstanceGroupManagers/updatePerInstanceConfigs

Required parameters: project, region, instanceGroupManager

Optional parameters: requestId

Body: 

{:perInstanceConfigs [{:name string,
                       :preservedState PreservedState,
                       :status string,
                       :fingerprint string}]}

Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close