GoogleApi.Compute.V1.Api.GlobalNetworkEndpointGroups (google_api_compute v0.30.0) View Source
API calls for all endpoints tagged GlobalNetworkEndpointGroups
.
Link to this section Summary
Functions
Attach a network endpoint to the specified network endpoint group.
Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.
Detach the network endpoint from the specified network endpoint group.
Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.
Creates a network endpoint group in the specified project using the parameters that are included in the request.
Retrieves the list of network endpoint groups that are located in the specified project.
Lists the network endpoints in the specified network endpoint group.
Link to this section Functions
compute_global_network_endpoint_groups_attach_network_endpoints(connection, project, network_endpoint_group, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_global_network_endpoint_groups_attach_network_endpoints( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Attach a network endpoint to the specified network endpoint group.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.network_endpoint_group
(type:String.t
) - The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.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.GlobalNetworkEndpointGroupsAttachEndpointsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success -
{:error, info}
on failure
compute_global_network_endpoint_groups_delete(connection, project, network_endpoint_group, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_global_network_endpoint_groups_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.network_endpoint_group
(type:String.t
) - The name of the network endpoint group to delete. It should comply with RFC1035.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_global_network_endpoint_groups_detach_network_endpoints(connection, project, network_endpoint_group, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_global_network_endpoint_groups_detach_network_endpoints( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Detach the network endpoint from the specified network endpoint group.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.network_endpoint_group
(type:String.t
) - The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.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.GlobalNetworkEndpointGroupsDetachEndpointsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success -
{:error, info}
on failure
compute_global_network_endpoint_groups_get(connection, project, network_endpoint_group, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_global_network_endpoint_groups_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.NetworkEndpointGroup.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.
Parameters
-
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to server -
project
(type:String.t
) - Project ID for this request. -
network_endpoint_group
(type:String.t
) - The name of the network endpoint group. It should comply with RFC1035. -
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.NetworkEndpointGroup{}}
on success -
{:error, info}
on failure
compute_global_network_endpoint_groups_insert(connection, project, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_global_network_endpoint_groups_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a network endpoint group in the specified project using the parameters that are included in the request.
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.: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.NetworkEndpointGroup.t
) -
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success -
{:error, info}
on failure
compute_global_network_endpoint_groups_list(connection, project, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_global_network_endpoint_groups_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.NetworkEndpointGroupList.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves the list of network endpoint groups that are located in the specified project.
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 specifyingname != example-instance
. You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
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 thanmaxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, 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 usingorderBy="creationTimestamp desc"
. This sorts results based on thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported.:pageToken
(type:String.t
) - Specifies a page token to use. SetpageToken
to thenextPageToken
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 and the logic is the same as today.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Compute.V1.Model.NetworkEndpointGroupList{}}
on success -
{:error, info}
on failure
compute_global_network_endpoint_groups_list_network_endpoints(connection, project, network_endpoint_group, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_global_network_endpoint_groups_list_network_endpoints( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.NetworkEndpointGroupsListNetworkEndpoints.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists the network endpoints in the specified network endpoint group.
Parameters
connection
(type:GoogleApi.Compute.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.network_endpoint_group
(type:String.t
) - The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.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 specifyingname != example-instance
. You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
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 thanmaxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, 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 usingorderBy="creationTimestamp desc"
. This sorts results based on thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported.:pageToken
(type:String.t
) - Specifies a page token to use. SetpageToken
to thenextPageToken
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 and the logic is the same as today.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Compute.V1.Model.NetworkEndpointGroupsListNetworkEndpoints{}}
on success -
{:error, info}
on failure