Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves an aggregated list of VPN tunnels.
See: Compute Engine API Reference for compute.vpnTunnels.aggregatedList
.
- type VPNTunnelsAggregatedListResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("aggregated" :> ("vpnTunnels" :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] VPNTunnelAggregatedList)))))))))
- vpnTunnelsAggregatedList :: Text -> VPNTunnelsAggregatedList
- data VPNTunnelsAggregatedList
- vtalProject :: Lens' VPNTunnelsAggregatedList Text
- vtalFilter :: Lens' VPNTunnelsAggregatedList (Maybe Text)
- vtalPageToken :: Lens' VPNTunnelsAggregatedList (Maybe Text)
- vtalMaxResults :: Lens' VPNTunnelsAggregatedList Word32
REST Resource
type VPNTunnelsAggregatedListResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("aggregated" :> ("vpnTunnels" :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] VPNTunnelAggregatedList))))))))) Source #
A resource alias for compute.vpnTunnels.aggregatedList
method which the
VPNTunnelsAggregatedList
request conforms to.
Creating a Request
vpnTunnelsAggregatedList Source #
Creates a value of VPNTunnelsAggregatedList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data VPNTunnelsAggregatedList Source #
Retrieves an aggregated list of VPN tunnels.
See: vpnTunnelsAggregatedList
smart constructor.
Request Lenses
vtalProject :: Lens' VPNTunnelsAggregatedList Text Source #
Project ID for this request.
vtalFilter :: Lens' VPNTunnelsAggregatedList (Maybe Text) Source #
Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
vtalPageToken :: Lens' VPNTunnelsAggregatedList (Maybe Text) Source #
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
vtalMaxResults :: Lens' VPNTunnelsAggregatedList Word32 Source #
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.