google_api_compute v0.11.0 GoogleApi.Compute.V1.Api.TargetPools View Source
API calls for all endpoints tagged TargetPools
.
Link to this section Summary
Functions
Adds health check URLs to a target pool.
Adds an instance to a target pool.
Retrieves an aggregated list of target pools.
Deletes the specified target pool.
Returns the specified target pool. Gets a list of available target pools by making a list() request.
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
Creates a target pool in the specified project and region using the data included in the request.
Retrieves a list of target pools available to the specified project and region.
Removes health check URL from a target pool.
Removes instance URL from a target pool.
Changes a backup target pool's configurations.
Link to this section Functions
compute_target_pools_add_health_check(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_add_health_check( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Adds health check URLs to a target pool.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.target_pool
(type:String.t
) - Name of the target pool to add a health check to.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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.TargetPoolsAddHealthCheckRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure
compute_target_pools_add_instance(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_add_instance( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Adds an instance to a target pool.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.target_pool
(type:String.t
) - Name of the TargetPool resource to add instances to.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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.TargetPoolsAddInstanceRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure
compute_target_pools_aggregated_list(connection, project, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_aggregated_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.TargetPoolAggregatedList.t()} | {:error, Tesla.Env.t()}
Retrieves an aggregated list of target pools.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:filter
(type:String.t
) - A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.
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).
: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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.TargetPoolAggregatedList{}}
on success{:error, info}
on failure
compute_target_pools_delete(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Deletes the specified target pool.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.target_pool
(type:String.t
) - Name of the TargetPool resource to delete.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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_target_pools_get(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.TargetPool.t()} | {:error, Tesla.Env.t()}
Returns the specified target pool. Gets a list of available target pools by making a list() request.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.target_pool
(type:String.t
) - Name of the TargetPool resource to return.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.TargetPool{}}
on success{:error, info}
on failure
compute_target_pools_get_health(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_get_health( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.TargetPoolInstanceHealth.t()} | {:error, Tesla.Env.t()}
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.target_pool
(type:String.t
) - Name of the TargetPool resource to which the queried instance belongs.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.Compute.V1.Model.InstanceReference.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.TargetPoolInstanceHealth{}}
on success{:error, info}
on failure
compute_target_pools_insert(connection, project, region, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_insert( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Creates a target pool in the specified project and region using the data included in the request.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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.TargetPool.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure
compute_target_pools_list(connection, project, region, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.TargetPoolList.t()} | {:error, Tesla.Env.t()}
Retrieves a list of target pools available to the specified project and region.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:filter
(type:String.t
) - A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.
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).
: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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.TargetPoolList{}}
on success{:error, info}
on failure
compute_target_pools_remove_health_check(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_remove_health_check( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Removes health check URL from a target pool.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region for this request.target_pool
(type:String.t
) - Name of the target pool to remove health checks from.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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.TargetPoolsRemoveHealthCheckRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure
compute_target_pools_remove_instance(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_remove_instance( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Removes instance URL from a target pool.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.target_pool
(type:String.t
) - Name of the TargetPool resource to remove instances from.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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.TargetPoolsRemoveInstanceRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure
compute_target_pools_set_backup(connection, project, region, target_pool, optional_params \\ [], opts \\ [])
View Sourcecompute_target_pools_set_backup( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Changes a backup target pool's configurations.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.region
(type:String.t
) - Name of the region scoping this request.target_pool
(type:String.t
) - Name of the TargetPool resource to set a backup pool for.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:failoverRatio
(type:number()
) - New failoverRatio value for the target pool.: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.TargetReference.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure