View Source GoogleApi.Compute.V1.Api.InstanceGroupManagerResizeRequests (google_api_compute v0.56.2)

API calls for all endpoints tagged InstanceGroupManagerResizeRequests.

Summary

Functions

compute_instance_group_manager_resize_requests_cancel(connection, project, zone, instance_group_manager, resize_request, optional_params \\ [], opts \\ [])

Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue.

compute_instance_group_manager_resize_requests_delete(connection, project, zone, instance_group_manager, resize_request, optional_params \\ [], opts \\ [])

Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.

compute_instance_group_manager_resize_requests_get(connection, project, zone, instance_group_manager, resize_request, optional_params \\ [], opts \\ [])

Returns all of the details about the specified resize request.

compute_instance_group_manager_resize_requests_insert(connection, project, zone, instance_group_manager, optional_params \\ [], opts \\ [])

Creates a new resize request that starts provisioning VMs immediately or queues VM creation.

compute_instance_group_manager_resize_requests_list(connection, project, zone, instance_group_manager, optional_params \\ [], opts \\ [])

Retrieves a list of resize requests that are contained in the managed instance group.

Functions

compute_instance_group_manager_resize_requests_cancel(connection, project, zone, instance_group_manager, resize_request, optional_params \\ [], opts \\ [])

@spec compute_instance_group_manager_resize_requests_cancel(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
project (type: String.t) - Project ID for this request.
zone (type: String.t) - The name of the zone where the managed instance group is located. The name should conform to RFC1035.
instance_group_manager (type: String.t) - The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.
resize_request (type: String.t) - The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
- :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Compute.V1.Model.Operation{}} on success
{:error, info} on failure

compute_instance_group_manager_resize_requests_delete(connection, project, zone, instance_group_manager, resize_request, optional_params \\ [], opts \\ [])

@spec compute_instance_group_manager_resize_requests_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.

Parameters

connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
project (type: String.t) - Project ID for this request.
zone (type: String.t) - The name of the zone where the managed instance group is located. The name should conform to RFC1035.
instance_group_manager (type: String.t) - The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.
resize_request (type: String.t) - The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
- :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Compute.V1.Model.Operation{}} on success
{:error, info} on failure

compute_instance_group_manager_resize_requests_get(connection, project, zone, instance_group_manager, resize_request, optional_params \\ [], opts \\ [])

@spec compute_instance_group_manager_resize_requests_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.InstanceGroupManagerResizeRequest.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all of the details about the specified resize request.

Parameters

connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
project (type: String.t) - Project ID for this request.
zone (type: String.t) - Name of the href="/compute/docs/regions-zones/#available">zone scoping this request. Name should conform to RFC1035.
instance_group_manager (type: String.t) - The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
resize_request (type: String.t) - The name of the resize request. Name should conform to RFC1035 or be a resource ID.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Compute.V1.Model.InstanceGroupManagerResizeRequest{}} on success
{:error, info} on failure

compute_instance_group_manager_resize_requests_insert(connection, project, zone, instance_group_manager, optional_params \\ [], opts \\ [])

@spec compute_instance_group_manager_resize_requests_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new resize request that starts provisioning VMs immediately or queues VM creation.

Parameters

connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
project (type: String.t) - Project ID for this request.
zone (type: String.t) - The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.
instance_group_manager (type: String.t) - The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
- :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- :body (type: GoogleApi.Compute.V1.Model.InstanceGroupManagerResizeRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Compute.V1.Model.Operation{}} on success
{:error, info} on failure

compute_instance_group_manager_resize_requests_list(connection, project, zone, instance_group_manager, optional_params \\ [], opts \\ [])

@spec compute_instance_group_manager_resize_requests_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Compute.V1.Model.InstanceGroupManagerResizeRequestsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of resize requests that are contained in the managed instance group.

Parameters

connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
project (type: String.t) - Project ID for this request.
zone (type: String.t) - The name of the zone where the managed instance group is located. The name should conform to RFC1035.
instance_group_manager (type: String.t) - The name of the managed instance group. The name should conform to RFC1035.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
- :filter (type: String.t) - A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.
- :maxResults (type: integer()) - The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
- :orderBy (type: String.t) - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
- :pageToken (type: String.t) - Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
- :returnPartialSuccess (type: boolean()) - Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Compute.V1.Model.InstanceGroupManagerResizeRequestsListResponse{}} on success
{:error, info} on failure