{-# LANGUAGE DataKinds #-} {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeOperators #-} {-# OPTIONS_GHC -fno-warn-duplicate-exports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} -- | -- Module : Network.Google.Resource.Compute.Instances.List -- Copyright : (c) 2015 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Retrieves the list of instance resources contained within the specified -- zone. -- -- /See:/ for @compute.instances.list@. module Network.Google.Resource.Compute.Instances.List ( -- * REST Resource InstancesListResource -- * Creating a Request , instancesList , InstancesList -- * Request Lenses , ilProject , ilZone , ilFilter , ilPageToken , ilMaxResults ) where import Network.Google.Compute.Types import Network.Google.Prelude -- | A resource alias for @compute.instances.list@ method which the -- 'InstancesList' request conforms to. type InstancesListResource = "compute" :> "v1" :> "projects" :> Capture "project" Text :> "zones" :> Capture "zone" Text :> "instances" :> QueryParam "filter" Text :> QueryParam "pageToken" Text :> QueryParam "maxResults" (Textual Word32) :> QueryParam "alt" AltJSON :> Get '[JSON] InstanceList -- | Retrieves the list of instance resources contained within the specified -- zone. -- -- /See:/ 'instancesList' smart constructor. data InstancesList = InstancesList { _ilProject :: !Text , _ilZone :: !Text , _ilFilter :: !(Maybe Text) , _ilPageToken :: !(Maybe Text) , _ilMaxResults :: !(Textual Word32) } deriving (Eq,Show,Data,Typeable,Generic) -- | Creates a value of 'InstancesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'ilProject' -- -- * 'ilZone' -- -- * 'ilFilter' -- -- * 'ilPageToken' -- -- * 'ilMaxResults' instancesList :: Text -- ^ 'ilProject' -> Text -- ^ 'ilZone' -> InstancesList instancesList pIlProject_ pIlZone_ = InstancesList { _ilProject = pIlProject_ , _ilZone = pIlZone_ , _ilFilter = Nothing , _ilPageToken = Nothing , _ilMaxResults = 500 } -- | Project ID for this request. ilProject :: Lens' InstancesList Text ilProject = lens _ilProject (\ s a -> s{_ilProject = a}) -- | The name of the zone for this request. ilZone :: Lens' InstancesList Text ilZone = lens _ilZone (\ s a -> s{_ilZone = a}) -- | 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 -- (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, filter=name ne -- example-instance. ilFilter :: Lens' InstancesList (Maybe Text) ilFilter = lens _ilFilter (\ s a -> s{_ilFilter = a}) -- | Specifies a page token to use. Use this parameter if you want to list -- the next page of results. Set pageToken to the nextPageToken returned by -- a previous list request. ilPageToken :: Lens' InstancesList (Maybe Text) ilPageToken = lens _ilPageToken (\ s a -> s{_ilPageToken = a}) -- | Maximum count of results to be returned. ilMaxResults :: Lens' InstancesList Word32 ilMaxResults = lens _ilMaxResults (\ s a -> s{_ilMaxResults = a}) . _Coerce instance GoogleRequest InstancesList where type Rs InstancesList = InstanceList requestClient InstancesList{..} = go _ilProject _ilZone _ilFilter _ilPageToken (Just _ilMaxResults) (Just AltJSON) computeService where go = buildClient (Proxy :: Proxy InstancesListResource) mempty