google_api_compute v0.17.0 GoogleApi.Compute.V1.Api.Routers View Source
API calls for all endpoints tagged Routers
.
Link to this section Summary
Functions
Retrieves an aggregated list of routers.
Deletes the specified Router resource.
Returns the specified Router resource. Gets a list of available routers by making a list() request.
Retrieves runtime Nat mapping information of VM endpoints.
Retrieves runtime information of the specified router.
Creates a Router resource in the specified project and region using the data included in the request.
Retrieves a list of Router resources available to the specified project.
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
Link to this section Functions
compute_routers_aggregated_list(connection, project, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_aggregated_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.RouterAggregatedList.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves an aggregated list of routers.
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 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 anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
:includeAllScopes
(type:boolean()
) - Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.: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 using
orderBy="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 by
name
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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.RouterAggregatedList{}}
on success{:error, info}
on failure
compute_routers_delete(connection, project, region, router, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes the specified Router resource.
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.router
(type:String.t
) - Name of the Router 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_routers_get(connection, project, region, router, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Router.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns the specified Router resource. Gets a list of available routers 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 for this request.router
(type:String.t
) - Name of the Router 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.Router{}}
on success{:error, info}
on failure
compute_routers_get_nat_mapping_info(connection, project, region, router, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_get_nat_mapping_info( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.VmEndpointNatMappingsList.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves runtime Nat mapping information of VM endpoints.
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.router
(type:String.t
) - Name of the Router resource to query for Nat Mapping information of VM endpoints.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 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 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 using
orderBy="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 by
name
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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.VmEndpointNatMappingsList{}}
on success{:error, info}
on failure
compute_routers_get_router_status(connection, project, region, router, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_get_router_status( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.RouterStatusResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves runtime information of the specified router.
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.router
(type:String.t
) - Name of the Router resource to query.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.RouterStatusResponse{}}
on success{:error, info}
on failure
compute_routers_insert(connection, project, region, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_insert( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a Router resource 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 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.Router.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure
compute_routers_list(connection, project, region, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.RouterList.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a list of Router resources available to the specified project.
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.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 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 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 using
orderBy="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 by
name
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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.RouterList{}}
on success{:error, info}
on failure
compute_routers_patch(connection, project, region, router, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
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.router
(type:String.t
) - Name of the Router resource to patch.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.Router.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure
compute_routers_preview(connection, project, region, router, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_preview( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.RoutersPreviewResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
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.router
(type:String.t
) - Name of the Router resource to query.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.Router.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.RoutersPreviewResponse{}}
on success{:error, info}
on failure
compute_routers_update(connection, project, region, router, optional_params \\ [], opts \\ [])
View SourceSpecs
compute_routers_update( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Compute.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
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.router
(type:String.t
) - Name of the Router resource to update.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.Router.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Compute.V1.Model.Operation{}}
on success{:error, info}
on failure