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 |
- Service Configuration
- OAuth Scopes
- OperationWarningsItemDataItem
- RollingUpdate
- RollingUpdateError
- OperationList
- InstanceUpdateList
- RollingUpdateErrorErrorsItem
- Operation
- InstanceUpdate
- InstanceUpdateError
- RollingUpdatePolicy
- OperationError
- OperationErrorErrorsItem
- InstanceUpdateErrorErrorsItem
- RollingUpdateList
- OperationWarningsItem
Synopsis
- replicaPoolUpdaterService :: ServiceConfig
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- replicapoolScope :: Proxy '["https://www.googleapis.com/auth/replicapool"]
- replicapoolReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/replicapool.readonly"]
- data OperationWarningsItemDataItem
- operationWarningsItemDataItem :: OperationWarningsItemDataItem
- owidiValue :: Lens' OperationWarningsItemDataItem (Maybe Text)
- owidiKey :: Lens' OperationWarningsItemDataItem (Maybe Text)
- data RollingUpdate
- rollingUpdate :: RollingUpdate
- ruStatus :: Lens' RollingUpdate (Maybe Text)
- ruProgress :: Lens' RollingUpdate (Maybe Int32)
- ruInstanceGroupManager :: Lens' RollingUpdate (Maybe Text)
- ruKind :: Lens' RollingUpdate Text
- ruError :: Lens' RollingUpdate (Maybe RollingUpdateError)
- ruInstanceTemplate :: Lens' RollingUpdate (Maybe Text)
- ruUser :: Lens' RollingUpdate (Maybe Text)
- ruSelfLink :: Lens' RollingUpdate (Maybe Text)
- ruStatusMessage :: Lens' RollingUpdate (Maybe Text)
- ruCreationTimestamp :: Lens' RollingUpdate (Maybe Text)
- ruId :: Lens' RollingUpdate (Maybe Text)
- ruPolicy :: Lens' RollingUpdate (Maybe RollingUpdatePolicy)
- ruActionType :: Lens' RollingUpdate (Maybe Text)
- ruOldInstanceTemplate :: Lens' RollingUpdate (Maybe Text)
- ruDescription :: Lens' RollingUpdate (Maybe Text)
- ruInstanceGroup :: Lens' RollingUpdate (Maybe Text)
- data RollingUpdateError
- rollingUpdateError :: RollingUpdateError
- rueErrors :: Lens' RollingUpdateError [RollingUpdateErrorErrorsItem]
- 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 InstanceUpdateList
- instanceUpdateList :: InstanceUpdateList
- iulNextPageToken :: Lens' InstanceUpdateList (Maybe Text)
- iulKind :: Lens' InstanceUpdateList Text
- iulItems :: Lens' InstanceUpdateList [InstanceUpdate]
- iulSelfLink :: Lens' InstanceUpdateList (Maybe Text)
- data RollingUpdateErrorErrorsItem
- rollingUpdateErrorErrorsItem :: RollingUpdateErrorErrorsItem
- rueeiLocation :: Lens' RollingUpdateErrorErrorsItem (Maybe Text)
- rueeiCode :: Lens' RollingUpdateErrorErrorsItem (Maybe Text)
- rueeiMessage :: Lens' RollingUpdateErrorErrorsItem (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 InstanceUpdate
- instanceUpdate :: InstanceUpdate
- iuStatus :: Lens' InstanceUpdate (Maybe Text)
- iuError :: Lens' InstanceUpdate (Maybe InstanceUpdateError)
- iuInstance :: Lens' InstanceUpdate (Maybe Text)
- data InstanceUpdateError
- instanceUpdateError :: InstanceUpdateError
- iueErrors :: Lens' InstanceUpdateError [InstanceUpdateErrorErrorsItem]
- data RollingUpdatePolicy
- rollingUpdatePolicy :: RollingUpdatePolicy
- rupMinInstanceUpdateTimeSec :: Lens' RollingUpdatePolicy (Maybe Int32)
- rupInstanceStartupTimeoutSec :: Lens' RollingUpdatePolicy (Maybe Int32)
- rupMaxNumFailedInstances :: Lens' RollingUpdatePolicy (Maybe Int32)
- rupAutoPauseAfterInstances :: Lens' RollingUpdatePolicy (Maybe Int32)
- rupMaxNumConcurrentInstances :: Lens' RollingUpdatePolicy (Maybe Int32)
- data OperationError
- operationError :: OperationError
- oeErrors :: Lens' OperationError [OperationErrorErrorsItem]
- data OperationErrorErrorsItem
- operationErrorErrorsItem :: OperationErrorErrorsItem
- oeeiLocation :: Lens' OperationErrorErrorsItem (Maybe Text)
- oeeiCode :: Lens' OperationErrorErrorsItem (Maybe Text)
- oeeiMessage :: Lens' OperationErrorErrorsItem (Maybe Text)
- data InstanceUpdateErrorErrorsItem
- instanceUpdateErrorErrorsItem :: InstanceUpdateErrorErrorsItem
- iueeiLocation :: Lens' InstanceUpdateErrorErrorsItem (Maybe Text)
- iueeiCode :: Lens' InstanceUpdateErrorErrorsItem (Maybe Text)
- iueeiMessage :: Lens' InstanceUpdateErrorErrorsItem (Maybe Text)
- data RollingUpdateList
- rollingUpdateList :: RollingUpdateList
- rulNextPageToken :: Lens' RollingUpdateList (Maybe Text)
- rulKind :: Lens' RollingUpdateList Text
- rulItems :: Lens' RollingUpdateList [RollingUpdate]
- rulSelfLink :: Lens' RollingUpdateList (Maybe Text)
- data OperationWarningsItem
- operationWarningsItem :: OperationWarningsItem
- owiData :: Lens' OperationWarningsItem [OperationWarningsItemDataItem]
- owiCode :: Lens' OperationWarningsItem (Maybe Text)
- owiMessage :: Lens' OperationWarningsItem (Maybe Text)
Service Configuration
replicaPoolUpdaterService :: ServiceConfig Source #
Default request referring to version v1beta1
of the Google Compute Engine Instance Group Updater API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
replicapoolScope :: Proxy '["https://www.googleapis.com/auth/replicapool"] Source #
View and manage replica pools
replicapoolReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/replicapool.readonly"] Source #
View replica pools
OperationWarningsItemDataItem
data OperationWarningsItemDataItem Source #
Instances
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.
RollingUpdate
data RollingUpdate Source #
The following represents a resource describing a single update (rollout) of a group of instances to the given template.
See: rollingUpdate
smart constructor.
Instances
rollingUpdate :: RollingUpdate Source #
Creates a value of RollingUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ruStatus :: Lens' RollingUpdate (Maybe Text) Source #
- Output Only
- Status of the update. Possible values are: - "ROLLING_FORWARD": The update is going forward. - "ROLLING_BACK": The update is being rolled back. - "PAUSED": The update is temporarily paused (inactive). - "ROLLED_OUT": The update is finished, all instances have been updated successfully. - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template. - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
ruProgress :: Lens' RollingUpdate (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 update will be complete. This number should be monotonically increasing as the update progresses.
ruInstanceGroupManager :: Lens' RollingUpdate (Maybe Text) Source #
Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
ruError :: Lens' RollingUpdate (Maybe RollingUpdateError) Source #
- Output Only
- Errors that occurred during the rolling update.
ruInstanceTemplate :: Lens' RollingUpdate (Maybe Text) Source #
Fully-qualified URL of an instance template to apply.
ruUser :: Lens' RollingUpdate (Maybe Text) Source #
- Output Only
- User who requested the update, for example: user'example.com.
ruSelfLink :: Lens' RollingUpdate (Maybe Text) Source #
- Output Only
- The fully qualified URL for the resource.
ruStatusMessage :: Lens' RollingUpdate (Maybe Text) Source #
- Output Only
- An optional textual description of the current status of the update.
ruCreationTimestamp :: Lens' RollingUpdate (Maybe Text) Source #
- Output Only
- Creation timestamp in RFC3339 text format.
ruId :: Lens' RollingUpdate (Maybe Text) Source #
- Output Only
- Unique identifier for the resource; defined by the server.
ruPolicy :: Lens' RollingUpdate (Maybe RollingUpdatePolicy) Source #
Parameters of the update process.
ruActionType :: Lens' RollingUpdate (Maybe Text) Source #
Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
ruOldInstanceTemplate :: Lens' RollingUpdate (Maybe Text) Source #
Fully-qualified URL of the instance template encountered while starting the update.
ruDescription :: Lens' RollingUpdate (Maybe Text) Source #
An optional textual description of the resource; provided by the client when the resource is created.
ruInstanceGroup :: Lens' RollingUpdate (Maybe Text) Source #
Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
RollingUpdateError
data RollingUpdateError Source #
- Output Only
- Errors that occurred during the rolling update.
See: rollingUpdateError
smart constructor.
Instances
rollingUpdateError :: RollingUpdateError Source #
Creates a value of RollingUpdateError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rueErrors :: Lens' RollingUpdateError [RollingUpdateErrorErrorsItem] Source #
- Output Only
- The array of errors encountered while processing this operation.
OperationList
data OperationList Source #
Contains a list of Operation resources.
See: operationList
smart constructor.
Instances
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 #
- Output Only
- A token used to continue a truncate.
olKind :: Lens' OperationList Text Source #
- Output Only
- Type of resource. Always replicapoolupdater#operationList for OperationList resources.
olSelfLink :: Lens' OperationList (Maybe Text) Source #
- Output Only
- The fully qualified URL for the resource.
olId :: Lens' OperationList (Maybe Text) Source #
- Output Only
- Unique identifier for the resource; defined by the server.
InstanceUpdateList
data InstanceUpdateList Source #
Response returned by ListInstanceUpdates method.
See: instanceUpdateList
smart constructor.
Instances
instanceUpdateList :: InstanceUpdateList Source #
Creates a value of InstanceUpdateList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iulNextPageToken :: Lens' InstanceUpdateList (Maybe Text) Source #
A token used to continue a truncated list request.
iulItems :: Lens' InstanceUpdateList [InstanceUpdate] Source #
Collection of requested instance updates.
iulSelfLink :: Lens' InstanceUpdateList (Maybe Text) Source #
- Output Only
- The fully qualified URL for the resource.
RollingUpdateErrorErrorsItem
data RollingUpdateErrorErrorsItem Source #
Instances
rollingUpdateErrorErrorsItem :: RollingUpdateErrorErrorsItem Source #
Creates a value of RollingUpdateErrorErrorsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rueeiLocation :: Lens' RollingUpdateErrorErrorsItem (Maybe Text) Source #
- Output Only
- Indicates the field in the request that caused the error. This property is optional.
rueeiCode :: Lens' RollingUpdateErrorErrorsItem (Maybe Text) Source #
- Output Only
- The error type identifier for this error.
rueeiMessage :: Lens' RollingUpdateErrorErrorsItem (Maybe Text) Source #
- Output Only
- An optional, human-readable error message.
Operation
An operation resource, used to manage asynchronous API requests.
See: operation
smart constructor.
Instances
operation :: Operation Source #
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.
oStatus :: Lens' Operation (Maybe Text) Source #
- Output Only
- Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
oInsertTime :: Lens' Operation (Maybe Text) Source #
- Output Only
- The time that this operation was requested. This is in RFC 3339 format.
oStartTime :: Lens' Operation (Maybe Text) Source #
- Output Only
- The time that this operation was started by the server. This is in RFC 3339 format.
oKind :: Lens' Operation Text Source #
- Output Only
- Type of the resource. Always replicapoolupdater#operation for Operation resources.
oError :: Lens' Operation (Maybe OperationError) Source #
- Output Only
- If errors occurred during processing of this operation, this field will be populated.
oZone :: Lens' Operation (Maybe Text) Source #
- Output Only
- URL of the zone where the operation resides.
oSelfLink :: Lens' Operation (Maybe Text) Source #
- Output Only
- The fully qualified URL for the 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
- Creation timestamp in RFC3339 text format.
oId :: Lens' Operation (Maybe Word64) Source #
- Output Only
- Unique identifier for the resource; defined by the server.
oRegion :: Lens' Operation (Maybe Text) Source #
- Output Only
- URL of the region where the operation resides.
oTargetLink :: Lens' Operation (Maybe Text) Source #
- Output Only
- URL of the resource the operation is mutating.
InstanceUpdate
data InstanceUpdate Source #
Update of a single instance.
See: instanceUpdate
smart constructor.
Instances
instanceUpdate :: InstanceUpdate Source #
Creates a value of InstanceUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iuStatus :: Lens' InstanceUpdate (Maybe Text) Source #
Status of the instance update. Possible values are: - "PENDING": The instance update is pending execution. - "ROLLING_FORWARD": The instance update is going forward. - "ROLLING_BACK": The instance update is being rolled back. - "PAUSED": The instance update is temporarily paused (inactive). - "ROLLED_OUT": The instance update is finished, the instance is running the new template. - "ROLLED_BACK": The instance update is finished, the instance has been reverted to the previous template. - "CANCELLED": The instance update is paused and no longer can be resumed, undefined in which template the instance is running.
iuError :: Lens' InstanceUpdate (Maybe InstanceUpdateError) Source #
Errors that occurred during the instance update.
iuInstance :: Lens' InstanceUpdate (Maybe Text) Source #
Fully-qualified URL of the instance being updated.
InstanceUpdateError
data InstanceUpdateError Source #
Errors that occurred during the instance update.
See: instanceUpdateError
smart constructor.
Instances
instanceUpdateError :: InstanceUpdateError Source #
Creates a value of InstanceUpdateError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iueErrors :: Lens' InstanceUpdateError [InstanceUpdateErrorErrorsItem] Source #
- Output Only
- The array of errors encountered while processing this operation.
RollingUpdatePolicy
data RollingUpdatePolicy Source #
Parameters of the update process.
See: rollingUpdatePolicy
smart constructor.
Instances
rollingUpdatePolicy :: RollingUpdatePolicy Source #
Creates a value of RollingUpdatePolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rupMinInstanceUpdateTimeSec :: Lens' RollingUpdatePolicy (Maybe Int32) Source #
The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
rupInstanceStartupTimeoutSec :: Lens' RollingUpdatePolicy (Maybe Int32) Source #
The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
rupMaxNumFailedInstances :: Lens' RollingUpdatePolicy (Maybe Int32) Source #
The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
rupAutoPauseAfterInstances :: Lens' RollingUpdatePolicy (Maybe Int32) Source #
Number of instances to update before the updater pauses the rolling update.
rupMaxNumConcurrentInstances :: Lens' RollingUpdatePolicy (Maybe Int32) Source #
The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
OperationError
data OperationError Source #
- Output Only
- If errors occurred during processing of this operation, this field will be populated.
See: operationError
smart constructor.
Instances
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.
OperationErrorErrorsItem
data OperationErrorErrorsItem Source #
Instances
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 that 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.
InstanceUpdateErrorErrorsItem
data InstanceUpdateErrorErrorsItem Source #
Instances
instanceUpdateErrorErrorsItem :: InstanceUpdateErrorErrorsItem Source #
Creates a value of InstanceUpdateErrorErrorsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iueeiLocation :: Lens' InstanceUpdateErrorErrorsItem (Maybe Text) Source #
- Output Only
- Indicates the field in the request that caused the error. This property is optional.
iueeiCode :: Lens' InstanceUpdateErrorErrorsItem (Maybe Text) Source #
- Output Only
- The error type identifier for this error.
iueeiMessage :: Lens' InstanceUpdateErrorErrorsItem (Maybe Text) Source #
- Output Only
- An optional, human-readable error message.
RollingUpdateList
data RollingUpdateList Source #
Response returned by List method.
See: rollingUpdateList
smart constructor.
Instances
rollingUpdateList :: RollingUpdateList Source #
Creates a value of RollingUpdateList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rulNextPageToken :: Lens' RollingUpdateList (Maybe Text) Source #
A token used to continue a truncated list request.
rulItems :: Lens' RollingUpdateList [RollingUpdate] Source #
Collection of requested updates.
rulSelfLink :: Lens' RollingUpdateList (Maybe Text) Source #
- Output Only
- The fully qualified URL for the resource.
OperationWarningsItem
data OperationWarningsItem Source #
Instances
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.