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 |
Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
See: Google Cloud Memorystore for Redis API Reference for redis.projects.locations.instances.list
.
Synopsis
- type ProjectsLocationsInstancesListResource = "v1" :> (Capture "parent" Text :> ("instances" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListInstancesResponse))))))))))
- projectsLocationsInstancesList :: Text -> ProjectsLocationsInstancesList
- data ProjectsLocationsInstancesList
- plilParent :: Lens' ProjectsLocationsInstancesList Text
- plilXgafv :: Lens' ProjectsLocationsInstancesList (Maybe Xgafv)
- plilUploadProtocol :: Lens' ProjectsLocationsInstancesList (Maybe Text)
- plilAccessToken :: Lens' ProjectsLocationsInstancesList (Maybe Text)
- plilUploadType :: Lens' ProjectsLocationsInstancesList (Maybe Text)
- plilPageToken :: Lens' ProjectsLocationsInstancesList (Maybe Text)
- plilPageSize :: Lens' ProjectsLocationsInstancesList (Maybe Int32)
- plilCallback :: Lens' ProjectsLocationsInstancesList (Maybe Text)
REST Resource
type ProjectsLocationsInstancesListResource = "v1" :> (Capture "parent" Text :> ("instances" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListInstancesResponse)))))))))) Source #
A resource alias for redis.projects.locations.instances.list
method which the
ProjectsLocationsInstancesList
request conforms to.
Creating a Request
projectsLocationsInstancesList Source #
Creates a value of ProjectsLocationsInstancesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProjectsLocationsInstancesList Source #
Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
See: projectsLocationsInstancesList
smart constructor.
Instances
Request Lenses
plilParent :: Lens' ProjectsLocationsInstancesList Text Source #
Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region
plilUploadProtocol :: Lens' ProjectsLocationsInstancesList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
plilAccessToken :: Lens' ProjectsLocationsInstancesList (Maybe Text) Source #
OAuth access token.
plilUploadType :: Lens' ProjectsLocationsInstancesList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
plilPageToken :: Lens' ProjectsLocationsInstancesList (Maybe Text) Source #
The next_page_token value returned from a previous List request, if any.
plilPageSize :: Lens' ProjectsLocationsInstancesList (Maybe Int32) Source #
The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
plilCallback :: Lens' ProjectsLocationsInstancesList (Maybe Text) Source #
JSONP