gogol-replicapool-0.0.1: Google Compute Engine Instance Group Manager SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.ReplicaPool.Types

Contents

Description

 

Synopsis

Service Configuration

replicaPoolService :: Service Source

Default request referring to version v1beta2 of the Google Compute Engine Instance Group Manager API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

computeScope :: OAuthScope Source

View and manage your Google Compute Engine resources

cloudPlatformReadOnlyScope :: OAuthScope Source

View your data across Google Cloud Platform services

cloudPlatformScope :: OAuthScope Source

View and manage your data across Google Cloud Platform services

computeReadonlyScope :: OAuthScope Source

View your Google Compute Engine resources

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.

InstanceGroupManagersAbandonInstancesRequest

data InstanceGroupManagersAbandonInstancesRequest Source

Instances

instanceGroupManagersAbandonInstancesRequest :: InstanceGroupManagersAbandonInstancesRequest Source

Creates a value of InstanceGroupManagersAbandonInstancesRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

igmairInstances :: Lens' InstanceGroupManagersAbandonInstancesRequest [Text] Source

The names of one or more instances to abandon. For example: { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }

InstanceGroupManagersSetInstanceTemplateRequest

data InstanceGroupManagersSetInstanceTemplateRequest Source

Instances

instanceGroupManagersSetInstanceTemplateRequest :: InstanceGroupManagersSetInstanceTemplateRequest Source

Creates a value of InstanceGroupManagersSetInstanceTemplateRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

igmsitrInstanceTemplate :: Lens' InstanceGroupManagersSetInstanceTemplateRequest (Maybe Text) Source

The full URL to an Instance Template from which all new instances will be created.

OperationWarningsItemCode

data OperationWarningsItemCode Source

Output only
The warning type identifier for this warning.

Constructors

DeprecatedResourceUsed
DEPRECATED_RESOURCE_USED
DiskSizeLargerThanImageSize
DISK_SIZE_LARGER_THAN_IMAGE_SIZE
InjectedKernelsDeprecated
INJECTED_KERNELS_DEPRECATED
NextHopAddressNotAssigned
NEXT_HOP_ADDRESS_NOT_ASSIGNED
NextHopCannotIPForward
NEXT_HOP_CANNOT_IP_FORWARD
NextHopInstanceNotFound
NEXT_HOP_INSTANCE_NOT_FOUND
NextHopInstanceNotOnNetwork
NEXT_HOP_INSTANCE_NOT_ON_NETWORK
NextHopNotRunning
NEXT_HOP_NOT_RUNNING
NoResultsOnPage
NO_RESULTS_ON_PAGE
RequiredTosAgreement
REQUIRED_TOS_AGREEMENT
ResourceNotDeleted
RESOURCE_NOT_DELETED
SingleInstancePropertyTemplate
SINGLE_INSTANCE_PROPERTY_TEMPLATE
Unreachable
UNREACHABLE

Instances

OperationList

data OperationList Source

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

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).

InstanceGroupManagerList

data InstanceGroupManagerList Source

Instances

instanceGroupManagerList :: InstanceGroupManagerList Source

Creates a value of InstanceGroupManagerList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

igmlNextPageToken :: Lens' InstanceGroupManagerList (Maybe Text) Source

A token used to continue a truncated list request (output only).

igmlKind :: Lens' InstanceGroupManagerList Text Source

Type of resource.

igmlItems :: Lens' InstanceGroupManagerList [InstanceGroupManager] Source

A list of instance resources.

igmlSelfLink :: Lens' InstanceGroupManagerList (Maybe Text) Source

Server defined URL for this resource (output only).

igmlId :: Lens' InstanceGroupManagerList (Maybe Text) Source

Unique identifier for the resource; defined by the server (output only).

ReplicaPoolAutoHealingPolicyActionType

data ReplicaPoolAutoHealingPolicyActionType Source

The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.

Constructors

Reboot
REBOOT
Recreate
RECREATE

Instances

Operation

data Operation Source

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 OperationStatus) Source

Output Only
Status of the operation.

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.

oKind :: Lens' Operation Text Source

Output only
Type of the resource.

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.

oName :: Lens' Operation (Maybe Text) Source

Output Only
Name of 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
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.

InstanceGroupManager

data InstanceGroupManager Source

An Instance Group Manager resource.

See: instanceGroupManager smart constructor.

Instances

instanceGroupManager :: InstanceGroupManager Source

Creates a value of InstanceGroupManager with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

igmCurrentSize :: Lens' InstanceGroupManager (Maybe Int32) Source

Output only
The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.

igmGroup :: Lens' InstanceGroupManager (Maybe Text) Source

Output only
The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.

igmKind :: Lens' InstanceGroupManager Text Source

Output only
The resource type. Always replicapool#instanceGroupManager.

igmFingerprint :: Lens' InstanceGroupManager (Maybe Word8) Source

Output only
Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.

igmBaseInstanceName :: Lens' InstanceGroupManager (Maybe Text) Source

The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

igmAutoHealingPolicies :: Lens' InstanceGroupManager [ReplicaPoolAutoHealingPolicy] Source

The autohealing policy for this managed instance group. You can specify only one value.

igmInstanceTemplate :: Lens' InstanceGroupManager (Maybe Text) Source

The full URL to an instance template from which all new instances will be created.

igmTargetSize :: Lens' InstanceGroupManager (Maybe Int32) Source

Output only
The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.

igmSelfLink :: Lens' InstanceGroupManager (Maybe Text) Source

Output only
The fully qualified URL for this resource.

igmName :: Lens' InstanceGroupManager (Maybe Text) Source

The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

igmCreationTimestamp :: Lens' InstanceGroupManager (Maybe Text) Source

Output only
The time the instance group manager was created, in RFC3339 text format.

igmId :: Lens' InstanceGroupManager (Maybe Word64) Source

Output only
A server-assigned unique identifier for the resource.

igmTargetPools :: Lens' InstanceGroupManager [Text] Source

The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.

igmDescription :: Lens' InstanceGroupManager (Maybe Text) Source

An optional textual description of the instance group manager.

ReplicaPoolAutoHealingPolicy

data ReplicaPoolAutoHealingPolicy Source

Instances

replicaPoolAutoHealingPolicy :: ReplicaPoolAutoHealingPolicy Source

Creates a value of ReplicaPoolAutoHealingPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rpahpHealthCheck :: Lens' ReplicaPoolAutoHealingPolicy (Maybe Text) Source

The URL for the HealthCheck that signals autohealing.

rpahpActionType :: Lens' ReplicaPoolAutoHealingPolicy (Maybe ReplicaPoolAutoHealingPolicyActionType) Source

The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.

InstanceGroupManagersRecreateInstancesRequest

data InstanceGroupManagersRecreateInstancesRequest Source

Instances

instanceGroupManagersRecreateInstancesRequest :: InstanceGroupManagersRecreateInstancesRequest Source

Creates a value of InstanceGroupManagersRecreateInstancesRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

igmrirInstances :: Lens' InstanceGroupManagersRecreateInstancesRequest [Text] Source

The names of one or more instances to recreate. For example: { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }

OperationStatus

data OperationStatus Source

Output Only
Status of the operation.

Constructors

Done
DONE
Pending
PENDING
Running
RUNNING

Instances

InstanceGroupManagersDeleteInstancesRequest

data InstanceGroupManagersDeleteInstancesRequest Source

Instances

instanceGroupManagersDeleteInstancesRequest :: InstanceGroupManagersDeleteInstancesRequest Source

Creates a value of InstanceGroupManagersDeleteInstancesRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

igmdirInstances :: Lens' InstanceGroupManagersDeleteInstancesRequest [Text] Source

Names of instances to delete. Example: 'instance-foo', 'instance-bar'

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.

InstanceGroupManagersSetTargetPoolsRequest

data InstanceGroupManagersSetTargetPoolsRequest Source

Instances

instanceGroupManagersSetTargetPoolsRequest :: InstanceGroupManagersSetTargetPoolsRequest Source

Creates a value of InstanceGroupManagersSetTargetPoolsRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

igmstprFingerprint :: Lens' InstanceGroupManagersSetTargetPoolsRequest (Maybe Word8) Source

The current fingerprint of the Instance Group Manager resource. If this does not match the server-side fingerprint of the resource, then the request will be rejected.

igmstprTargetPools :: Lens' InstanceGroupManagersSetTargetPoolsRequest [Text] Source

A list of fully-qualified URLs to existing Target Pool resources. New instances in the Instance Group Manager will be added to the specified target pools; existing instances are not affected.

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 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.

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 OperationWarningsItemCode) 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.