google_api_replica_pool v0.1.0 GoogleApi.ReplicaPool.V1beta2.Api.InstanceGroupManagers View Source

API calls for all endpoints tagged InstanceGroupManagers.

Link to this section Summary

Functions

replicapool_instance_group_managers_abandon_instances(connection, project, zone, instance_group_manager, opts \\ [])

Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.

replicapool_instance_group_managers_delete(connection, project, zone, instance_group_manager, opts \\ [])

Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.

replicapool_instance_group_managers_delete_instances(connection, project, zone, instance_group_manager, opts \\ [])

Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.

replicapool_instance_group_managers_get(connection, project, zone, instance_group_manager, opts \\ [])

Returns the specified Instance Group Manager resource.

replicapool_instance_group_managers_insert(connection, project, zone, size, opts \\ [])

Creates an instance group manager, as well as the instance group and the specified number of instances.

replicapool_instance_group_managers_list(connection, project, zone, opts \\ [])

Retrieves the list of Instance Group Manager resources contained within the specified zone.

replicapool_instance_group_managers_recreate_instances(connection, project, zone, instance_group_manager, opts \\ [])

Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.

replicapool_instance_group_managers_resize(connection, project, zone, instance_group_manager, size, opts \\ [])

Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.

replicapool_instance_group_managers_set_instance_template(connection, project, zone, instance_group_manager, opts \\ [])

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

replicapool_instance_group_managers_set_target_pools(connection, project, zone, instance_group_manager, opts \\ [])

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

Link to this section Functions

replicapool_instance_group_managers_abandon_instances(connection, project, zone, instance_group_manager, opts \\ [])

replicapool_instance_group_managers_abandon_instances(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): The name of the instance group manager.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (InstanceGroupManagersAbandonInstancesRequest):

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure

replicapool_instance_group_managers_delete(connection, project, zone, instance_group_manager, opts \\ [])

replicapool_instance_group_managers_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): Name of the Instance Group Manager resource to delete.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure

replicapool_instance_group_managers_delete_instances(connection, project, zone, instance_group_manager, opts \\ [])

replicapool_instance_group_managers_delete_instances(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): The name of the instance group manager.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (InstanceGroupManagersDeleteInstancesRequest):

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure

replicapool_instance_group_managers_get(connection, project, zone, instance_group_manager, opts \\ [])

replicapool_instance_group_managers_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.InstanceGroupManager.t()}
  | {:error, Tesla.Env.t()}

Returns the specified Instance Group Manager resource.

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): Name of the instance resource to return.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.InstanceGroupManager{}} on success {:error, info} on failure

replicapool_instance_group_managers_insert(connection, project, zone, size, opts \\ [])

replicapool_instance_group_managers_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  Integer.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Creates an instance group manager, as well as the instance group and the specified number of instances.

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
size (Integer): Number of instances that should exist.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (InstanceGroupManager):

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure

replicapool_instance_group_managers_list(connection, project, zone, opts \\ [])

replicapool_instance_group_managers_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.InstanceGroupManagerList.t()}
  | {:error, Tesla.Env.t()}

Retrieves the list of Instance Group Manager resources contained within the specified zone.

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :filter (String): Optional. Filter expression for filtering listed resources.
- :max_results (Integer): Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- :page_token (String): Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.InstanceGroupManagerList{}} on success {:error, info} on failure

replicapool_instance_group_managers_recreate_instances(connection, project, zone, instance_group_manager, opts \\ [])

replicapool_instance_group_managers_recreate_instances(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): The name of the instance group manager.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (InstanceGroupManagersRecreateInstancesRequest):

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure

replicapool_instance_group_managers_resize(connection, project, zone, instance_group_manager, size, opts \\ [])

replicapool_instance_group_managers_resize(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  Integer.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): The name of the instance group manager.
size (Integer): Number of instances that should exist in this Instance Group Manager.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure

replicapool_instance_group_managers_set_instance_template(connection, project, zone, instance_group_manager, opts \\ [])

replicapool_instance_group_managers_set_instance_template(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): The name of the instance group manager.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (InstanceGroupManagersSetInstanceTemplateRequest):

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure

replicapool_instance_group_managers_set_target_pools(connection, project, zone, instance_group_manager, opts \\ [])

replicapool_instance_group_managers_set_target_pools(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta2.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

connection (GoogleApi.ReplicaPool.V1beta2.Connection): Connection to server
project (String): The Google Developers Console project name.
zone (String): The name of the zone in which the instance group manager resides.
instance_group_manager (String): The name of the instance group manager.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (InstanceGroupManagersSetTargetPoolsRequest):

Returns

{:ok, %GoogleApi.ReplicaPool.V1beta2.Model.Operation{}} on success {:error, info} on failure