Copyright | (c) 2015 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 |
- Service Configuration
- API Declaration
- Resources
- resourceviews.zoneOperations.get
- resourceviews.zoneOperations.list
- resourceviews.zoneViews.addResources
- resourceviews.zoneViews.delete
- resourceviews.zoneViews.get
- resourceviews.zoneViews.getService
- resourceviews.zoneViews.insert
- resourceviews.zoneViews.list
- resourceviews.zoneViews.listResources
- resourceviews.zoneViews.removeResources
- resourceviews.zoneViews.setService
- Types
- OperationWarningsItemDataItem
- OperationList
- ResourceView
- ZoneViewsList
- Operation
- ZoneViewsListResourcesFormat
- ZoneViewsListResourcesResponse
- ServiceEndpoint
- ZoneViewsListResourcesListState
- ZoneViewsRemoveResourcesRequest
- ListResourceResponseItemEndpoints
- ZoneViewsAddResourcesRequest
- OperationError
- ZoneViewsGetServiceResponse
- OperationErrorErrorsItem
- ZoneViewsSetServiceRequest
- ListResourceResponseItem
- Label
- OperationWarningsItem
The Resource View API allows users to create and manage logical sets of Google Compute Engine instances.
- resourceViewsService :: Service
- type ResourceViewsAPI = ZoneViewsSetServiceResource :<|> (ZoneViewsInsertResource :<|> (ZoneViewsListResource :<|> (ZoneViewsListResourcesResource :<|> (ZoneViewsGetResource :<|> (ZoneViewsRemoveResourcesResource :<|> (ZoneViewsAddResourcesResource :<|> (ZoneViewsGetServiceResource :<|> (ZoneViewsDeleteResource :<|> (ZoneOperationsListResource :<|> ZoneOperationsGetResource)))))))))
- module Network.Google.Resource.ResourceViews.ZoneOperations.Get
- module Network.Google.Resource.ResourceViews.ZoneOperations.List
- module Network.Google.Resource.ResourceViews.ZoneViews.AddResources
- module Network.Google.Resource.ResourceViews.ZoneViews.Delete
- module Network.Google.Resource.ResourceViews.ZoneViews.Get
- module Network.Google.Resource.ResourceViews.ZoneViews.GetService
- module Network.Google.Resource.ResourceViews.ZoneViews.Insert
- module Network.Google.Resource.ResourceViews.ZoneViews.List
- module Network.Google.Resource.ResourceViews.ZoneViews.ListResources
- module Network.Google.Resource.ResourceViews.ZoneViews.RemoveResources
- module Network.Google.Resource.ResourceViews.ZoneViews.SetService
- data OperationWarningsItemDataItem
- operationWarningsItemDataItem :: OperationWarningsItemDataItem
- owidiValue :: Lens' OperationWarningsItemDataItem (Maybe Text)
- owidiKey :: Lens' OperationWarningsItemDataItem (Maybe Text)
- data OperationList
- operationList :: OperationList
- olNextPageToken :: Lens' OperationList (Maybe Text)
- olKind :: Lens' OperationList Text
- olItems :: Lens' OperationList [Operation]
- olSelfLink :: Lens' OperationList (Maybe Text)
- olId :: Lens' OperationList (Maybe Text)
- data ResourceView
- resourceView :: ResourceView
- rvSize :: Lens' ResourceView (Maybe Word32)
- rvKind :: Lens' ResourceView Text
- rvFingerprint :: Lens' ResourceView (Maybe Text)
- rvNetwork :: Lens' ResourceView (Maybe Text)
- rvResources :: Lens' ResourceView [Text]
- rvSelfLink :: Lens' ResourceView (Maybe Text)
- rvName :: Lens' ResourceView (Maybe Text)
- rvCreationTimestamp :: Lens' ResourceView (Maybe Text)
- rvId :: Lens' ResourceView (Maybe Text)
- rvLabels :: Lens' ResourceView [Label]
- rvEndpoints :: Lens' ResourceView [ServiceEndpoint]
- rvDescription :: Lens' ResourceView (Maybe Text)
- data ZoneViewsList
- zoneViewsList :: ZoneViewsList
- zvlNextPageToken :: Lens' ZoneViewsList (Maybe Text)
- zvlKind :: Lens' ZoneViewsList Text
- zvlItems :: Lens' ZoneViewsList [ResourceView]
- zvlSelfLink :: Lens' ZoneViewsList (Maybe Text)
- data Operation
- operation :: Operation
- oTargetId :: Lens' Operation (Maybe Word64)
- oStatus :: Lens' Operation (Maybe Text)
- oInsertTime :: Lens' Operation (Maybe Text)
- oProgress :: Lens' Operation (Maybe Int32)
- oStartTime :: Lens' Operation (Maybe Text)
- oKind :: Lens' Operation Text
- oError :: Lens' Operation (Maybe OperationError)
- oHTTPErrorMessage :: Lens' Operation (Maybe Text)
- oZone :: Lens' Operation (Maybe Text)
- oWarnings :: Lens' Operation [OperationWarningsItem]
- oHTTPErrorStatusCode :: Lens' Operation (Maybe Int32)
- oUser :: Lens' Operation (Maybe Text)
- oSelfLink :: Lens' Operation (Maybe Text)
- oName :: Lens' Operation (Maybe Text)
- oStatusMessage :: Lens' Operation (Maybe Text)
- oCreationTimestamp :: Lens' Operation (Maybe Text)
- oEndTime :: Lens' Operation (Maybe Text)
- oId :: Lens' Operation (Maybe Word64)
- oOperationType :: Lens' Operation (Maybe Text)
- oRegion :: Lens' Operation (Maybe Text)
- oTargetLink :: Lens' Operation (Maybe Text)
- oClientOperationId :: Lens' Operation (Maybe Text)
- data ZoneViewsListResourcesFormat
- data ZoneViewsListResourcesResponse
- zoneViewsListResourcesResponse :: ZoneViewsListResourcesResponse
- zvlrrNextPageToken :: Lens' ZoneViewsListResourcesResponse (Maybe Text)
- zvlrrItems :: Lens' ZoneViewsListResourcesResponse [ListResourceResponseItem]
- zvlrrNetwork :: Lens' ZoneViewsListResourcesResponse (Maybe Text)
- data ServiceEndpoint
- serviceEndpoint :: ServiceEndpoint
- seName :: Lens' ServiceEndpoint (Maybe Text)
- sePort :: Lens' ServiceEndpoint (Maybe Int32)
- data ZoneViewsListResourcesListState
- data ZoneViewsRemoveResourcesRequest
- zoneViewsRemoveResourcesRequest :: ZoneViewsRemoveResourcesRequest
- zvrrrResources :: Lens' ZoneViewsRemoveResourcesRequest [Text]
- data ListResourceResponseItemEndpoints
- listResourceResponseItemEndpoints :: HashMap Text [Int32] -> ListResourceResponseItemEndpoints
- lrrieAddtional :: Lens' ListResourceResponseItemEndpoints (HashMap Text [Int32])
- data ZoneViewsAddResourcesRequest
- zoneViewsAddResourcesRequest :: ZoneViewsAddResourcesRequest
- zvarrResources :: Lens' ZoneViewsAddResourcesRequest [Text]
- data OperationError
- operationError :: OperationError
- oeErrors :: Lens' OperationError [OperationErrorErrorsItem]
- data ZoneViewsGetServiceResponse
- zoneViewsGetServiceResponse :: ZoneViewsGetServiceResponse
- zvgsrFingerprint :: Lens' ZoneViewsGetServiceResponse (Maybe Text)
- zvgsrEndpoints :: Lens' ZoneViewsGetServiceResponse [ServiceEndpoint]
- data OperationErrorErrorsItem
- operationErrorErrorsItem :: OperationErrorErrorsItem
- oeeiLocation :: Lens' OperationErrorErrorsItem (Maybe Text)
- oeeiCode :: Lens' OperationErrorErrorsItem (Maybe Text)
- oeeiMessage :: Lens' OperationErrorErrorsItem (Maybe Text)
- data ZoneViewsSetServiceRequest
- zoneViewsSetServiceRequest :: ZoneViewsSetServiceRequest
- zvssrResourceName :: Lens' ZoneViewsSetServiceRequest (Maybe Text)
- zvssrFingerprint :: Lens' ZoneViewsSetServiceRequest (Maybe Text)
- zvssrEndpoints :: Lens' ZoneViewsSetServiceRequest [ServiceEndpoint]
- data ListResourceResponseItem
- listResourceResponseItem :: ListResourceResponseItem
- lrriResource :: Lens' ListResourceResponseItem (Maybe Text)
- lrriEndpoints :: Lens' ListResourceResponseItem (Maybe ListResourceResponseItemEndpoints)
- data Label
- label :: Label
- lValue :: Lens' Label (Maybe Text)
- lKey :: Lens' Label (Maybe Text)
- data OperationWarningsItem
- operationWarningsItem :: OperationWarningsItem
- owiData :: Lens' OperationWarningsItem [OperationWarningsItemDataItem]
- owiCode :: Lens' OperationWarningsItem (Maybe Text)
- owiMessage :: Lens' OperationWarningsItem (Maybe Text)
Service Configuration
resourceViewsService :: Service Source
Default request referring to version v1beta2
of the Google Compute Engine Instance Groups API. This contains the host and root path used as a starting point for constructing service requests.
API Declaration
type ResourceViewsAPI = ZoneViewsSetServiceResource :<|> (ZoneViewsInsertResource :<|> (ZoneViewsListResource :<|> (ZoneViewsListResourcesResource :<|> (ZoneViewsGetResource :<|> (ZoneViewsRemoveResourcesResource :<|> (ZoneViewsAddResourcesResource :<|> (ZoneViewsGetServiceResource :<|> (ZoneViewsDeleteResource :<|> (ZoneOperationsListResource :<|> ZoneOperationsGetResource))))))))) Source
Represents the entirety of the methods and resources available for the Google Compute Engine Instance Groups API service.
Resources
resourceviews.zoneOperations.get
resourceviews.zoneOperations.list
resourceviews.zoneViews.addResources
resourceviews.zoneViews.delete
resourceviews.zoneViews.get
resourceviews.zoneViews.getService
resourceviews.zoneViews.insert
resourceviews.zoneViews.list
resourceviews.zoneViews.listResources
resourceviews.zoneViews.removeResources
resourceviews.zoneViews.setService
Types
OperationWarningsItemDataItem
data OperationWarningsItemDataItem Source
operationWarningsItemDataItem :: OperationWarningsItemDataItem Source
Creates a value of OperationWarningsItemDataItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
owidiValue :: Lens' OperationWarningsItemDataItem (Maybe Text) Source
- Output Only
- Metadata value for this warning.
owidiKey :: Lens' OperationWarningsItemDataItem (Maybe Text) Source
- Output Only
- Metadata key for this warning.
OperationList
data OperationList Source
operationList :: OperationList Source
Creates a value of OperationList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
olNextPageToken :: Lens' OperationList (Maybe Text) Source
A token used to continue a truncated list request (output only).
olKind :: Lens' OperationList Text Source
Type of resource.
olItems :: Lens' OperationList [Operation] Source
The operation resources.
olSelfLink :: Lens' OperationList (Maybe Text) Source
Server defined URL for this resource (output only).
olId :: Lens' OperationList (Maybe Text) Source
Unique identifier for the resource; defined by the server (output only).
ResourceView
data ResourceView Source
The resource view object.
See: resourceView
smart constructor.
resourceView :: ResourceView Source
Creates a value of ResourceView
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rvSize :: Lens' ResourceView (Maybe Word32) Source
The total number of resources in the resource view.
rvKind :: Lens' ResourceView Text Source
Type of the resource.
rvFingerprint :: Lens' ResourceView (Maybe Text) Source
The fingerprint of the service endpoint information.
rvNetwork :: Lens' ResourceView (Maybe Text) Source
The URL of a Compute Engine network to which the resources in the view belong.
rvResources :: Lens' ResourceView [Text] Source
A list of all resources in the resource view.
rvSelfLink :: Lens' ResourceView (Maybe Text) Source
- Output Only
- A self-link to the resource view.
rvCreationTimestamp :: Lens' ResourceView (Maybe Text) Source
The creation time of the resource view.
rvLabels :: Lens' ResourceView [Label] Source
The labels for events.
rvEndpoints :: Lens' ResourceView [ServiceEndpoint] Source
Services endpoint information.
rvDescription :: Lens' ResourceView (Maybe Text) Source
The detailed description of the resource view.
ZoneViewsList
data ZoneViewsList Source
The response to a list request.
See: zoneViewsList
smart constructor.
zoneViewsList :: ZoneViewsList Source
Creates a value of ZoneViewsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
zvlNextPageToken :: Lens' ZoneViewsList (Maybe Text) Source
A token used for pagination.
zvlKind :: Lens' ZoneViewsList Text Source
Type of resource.
zvlItems :: Lens' ZoneViewsList [ResourceView] Source
The result that contains all resource views that meet the criteria.
zvlSelfLink :: Lens' ZoneViewsList (Maybe Text) Source
Server defined URL for this resource (output only).
Operation
An operation resource, used to manage asynchronous API requests.
See: operation
smart constructor.
Creates a value of Operation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oTargetId :: Lens' Operation (Maybe Word64) Source
- Output Only
- Unique target ID which identifies a particular incarnation of the target.
oInsertTime :: Lens' Operation (Maybe Text) Source
- Output Only
- The time that this operation was requested, in RFC3339 text format.
oProgress :: Lens' Operation (Maybe Int32) Source
- Output only
- An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
oStartTime :: Lens' Operation (Maybe Text) Source
- Output Only
- The time that this operation was started by the server, in RFC3339 text format.
oError :: Lens' Operation (Maybe OperationError) Source
- Output Only
- If errors occurred during processing of this operation, this field will be populated.
oHTTPErrorMessage :: Lens' Operation (Maybe Text) Source
- Output only
- If operation fails, the HTTP error message returned.
oZone :: Lens' Operation (Maybe Text) Source
- Output Only
- URL of the zone where the operation resides. Only available when performing per-zone operations.
oWarnings :: Lens' Operation [OperationWarningsItem] Source
- Output Only
- If there are issues with this operation, a warning is returned.
oHTTPErrorStatusCode :: Lens' Operation (Maybe Int32) Source
- Output only
- If operation fails, the HTTP error status code returned.
oUser :: Lens' Operation (Maybe Text) Source
- Output Only
- User who requested the operation, for example: user'example.com.
oSelfLink :: Lens' Operation (Maybe Text) Source
- Output Only
- Server-defined fully-qualified URL for this resource.
oStatusMessage :: Lens' Operation (Maybe Text) Source
- Output Only
- An optional textual description of the current status of the operation.
oCreationTimestamp :: Lens' Operation (Maybe Text) Source
- Output Only
- The time that this operation was requested, in RFC3339 text format.
oEndTime :: Lens' Operation (Maybe Text) Source
- Output Only
- The time that this operation was completed, in RFC3339 text format.
oId :: Lens' Operation (Maybe Word64) Source
- Output Only
- Unique identifier for the resource, generated by the server.
oOperationType :: Lens' Operation (Maybe Text) Source
- Output only
- Type of the operation. Operations include insert, update, and delete.
oRegion :: Lens' Operation (Maybe Text) Source
- Output Only
- URL of the region where the operation resides. Only available when performing regional operations.
oTargetLink :: Lens' Operation (Maybe Text) Source
- Output only
- URL of the resource the operation is mutating.
oClientOperationId :: Lens' Operation (Maybe Text) Source
- Output only
- An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
ZoneViewsListResourcesFormat
data ZoneViewsListResourcesFormat Source
The requested format of the return value. It can be URL or URL_PORT. A JSON object will be included in the response based on the format. The default format is NONE, which results in no JSON in the response.
ZoneViewsListResourcesResponse
data ZoneViewsListResourcesResponse Source
The response to a list resource request.
See: zoneViewsListResourcesResponse
smart constructor.
zoneViewsListResourcesResponse :: ZoneViewsListResourcesResponse Source
Creates a value of ZoneViewsListResourcesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
zvlrrNextPageToken :: Lens' ZoneViewsListResourcesResponse (Maybe Text) Source
A token used for pagination.
zvlrrItems :: Lens' ZoneViewsListResourcesResponse [ListResourceResponseItem] Source
The formatted JSON that is requested by the user.
zvlrrNetwork :: Lens' ZoneViewsListResourcesResponse (Maybe Text) Source
The URL of a Compute Engine network to which the resources in the view belong.
ServiceEndpoint
data ServiceEndpoint Source
The service endpoint that may be started in a VM.
See: serviceEndpoint
smart constructor.
serviceEndpoint :: ServiceEndpoint Source
Creates a value of ServiceEndpoint
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ZoneViewsListResourcesListState
data ZoneViewsListResourcesListState Source
The state of the instance to list. By default, it lists all instances.
ZoneViewsRemoveResourcesRequest
data ZoneViewsRemoveResourcesRequest Source
The request to remove resources from the resource view.
See: zoneViewsRemoveResourcesRequest
smart constructor.
zoneViewsRemoveResourcesRequest :: ZoneViewsRemoveResourcesRequest Source
Creates a value of ZoneViewsRemoveResourcesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
zvrrrResources :: Lens' ZoneViewsRemoveResourcesRequest [Text] Source
The list of resources to be removed.
ListResourceResponseItemEndpoints
data ListResourceResponseItemEndpoints Source
The list of service end points on the resource.
See: listResourceResponseItemEndpoints
smart constructor.
listResourceResponseItemEndpoints Source
Creates a value of ListResourceResponseItemEndpoints
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrrieAddtional :: Lens' ListResourceResponseItemEndpoints (HashMap Text [Int32]) Source
The name of the service end point.
ZoneViewsAddResourcesRequest
data ZoneViewsAddResourcesRequest Source
The request to add resources to the resource view.
See: zoneViewsAddResourcesRequest
smart constructor.
zoneViewsAddResourcesRequest :: ZoneViewsAddResourcesRequest Source
Creates a value of ZoneViewsAddResourcesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
zvarrResources :: Lens' ZoneViewsAddResourcesRequest [Text] Source
The list of resources to be added.
OperationError
data OperationError Source
- Output Only
- If errors occurred during processing of this operation, this field will be populated.
See: operationError
smart constructor.
operationError :: OperationError Source
Creates a value of OperationError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oeErrors :: Lens' OperationError [OperationErrorErrorsItem] Source
- Output Only
- The array of errors encountered while processing this operation.
ZoneViewsGetServiceResponse
zoneViewsGetServiceResponse :: ZoneViewsGetServiceResponse Source
Creates a value of ZoneViewsGetServiceResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
zvgsrFingerprint :: Lens' ZoneViewsGetServiceResponse (Maybe Text) Source
The fingerprint of the service information.
zvgsrEndpoints :: Lens' ZoneViewsGetServiceResponse [ServiceEndpoint] Source
The service information.
OperationErrorErrorsItem
operationErrorErrorsItem :: OperationErrorErrorsItem Source
Creates a value of OperationErrorErrorsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oeeiLocation :: Lens' OperationErrorErrorsItem (Maybe Text) Source
- Output Only
- Indicates the field in the request which caused the error. This property is optional.
oeeiCode :: Lens' OperationErrorErrorsItem (Maybe Text) Source
- Output Only
- The error type identifier for this error.
oeeiMessage :: Lens' OperationErrorErrorsItem (Maybe Text) Source
- Output Only
- An optional, human-readable error message.
ZoneViewsSetServiceRequest
zoneViewsSetServiceRequest :: ZoneViewsSetServiceRequest Source
Creates a value of ZoneViewsSetServiceRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
zvssrResourceName :: Lens' ZoneViewsSetServiceRequest (Maybe Text) Source
The name of the resource if user wants to update the service information of the resource.
zvssrFingerprint :: Lens' ZoneViewsSetServiceRequest (Maybe Text) Source
Fingerprint of the service information; a hash of the contents. This field is used for optimistic locking when updating the service entries.
zvssrEndpoints :: Lens' ZoneViewsSetServiceRequest [ServiceEndpoint] Source
The service information to be updated.
ListResourceResponseItem
data ListResourceResponseItem Source
The list response item that contains the resource and end points information.
See: listResourceResponseItem
smart constructor.
listResourceResponseItem :: ListResourceResponseItem Source
Creates a value of ListResourceResponseItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrriResource :: Lens' ListResourceResponseItem (Maybe Text) Source
The full URL of the resource.
lrriEndpoints :: Lens' ListResourceResponseItem (Maybe ListResourceResponseItemEndpoints) Source
The list of service end points on the resource.
Label
The Label to be applied to the resource views.
See: label
smart constructor.
OperationWarningsItem
operationWarningsItem :: OperationWarningsItem Source
Creates a value of OperationWarningsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
owiData :: Lens' OperationWarningsItem [OperationWarningsItemDataItem] Source
- Output only
- Metadata for this warning in key:value format.
owiCode :: Lens' OperationWarningsItem (Maybe Text) Source
- Output only
- The warning type identifier for this warning.
owiMessage :: Lens' OperationWarningsItem (Maybe Text) Source
- Output only
- Optional human-readable details for this warning.