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 the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances.
See: Compute Engine API Reference for compute.instances.listReferrers
.
Synopsis
- type InstancesListReferrersResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instances" :> (Capture "instance" Text :> ("referrers" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] InstanceListReferrers)))))))))))))
- instancesListReferrers :: Text -> Text -> Text -> InstancesListReferrers
- data InstancesListReferrers
- ilrOrderBy :: Lens' InstancesListReferrers (Maybe Text)
- ilrProject :: Lens' InstancesListReferrers Text
- ilrZone :: Lens' InstancesListReferrers Text
- ilrFilter :: Lens' InstancesListReferrers (Maybe Text)
- ilrPageToken :: Lens' InstancesListReferrers (Maybe Text)
- ilrMaxResults :: Lens' InstancesListReferrers Word32
- ilrInstance :: Lens' InstancesListReferrers Text
REST Resource
type InstancesListReferrersResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instances" :> (Capture "instance" Text :> ("referrers" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] InstanceListReferrers))))))))))))) Source #
A resource alias for compute.instances.listReferrers
method which the
InstancesListReferrers
request conforms to.
Creating a Request
instancesListReferrers Source #
Creates a value of InstancesListReferrers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data InstancesListReferrers Source #
Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances.
See: instancesListReferrers
smart constructor.
Instances
Request Lenses
ilrOrderBy :: Lens' InstancesListReferrers (Maybe Text) Source #
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 the creationTimestamp 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 or creationTimestamp desc is supported.
ilrProject :: Lens' InstancesListReferrers Text Source #
Project ID for this request.
ilrFilter :: Lens' InstancesListReferrers (Maybe Text) Source #
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 specifying name != 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 an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
ilrPageToken :: Lens' InstancesListReferrers (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.
ilrMaxResults :: Lens' InstancesListReferrers 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
ilrInstance :: Lens' InstancesListReferrers Text Source #
Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.