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 |
Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on resource name.
See: Cloud Spanner API Reference for spanner.projects.instances.patch
.
Synopsis
- type ProjectsInstancesPatchResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] UpdateInstanceRequest :> Patch '[JSON] Operation))))))))
- projectsInstancesPatch :: UpdateInstanceRequest -> Text -> ProjectsInstancesPatch
- data ProjectsInstancesPatch
- pipXgafv :: Lens' ProjectsInstancesPatch (Maybe Xgafv)
- pipUploadProtocol :: Lens' ProjectsInstancesPatch (Maybe Text)
- pipAccessToken :: Lens' ProjectsInstancesPatch (Maybe Text)
- pipUploadType :: Lens' ProjectsInstancesPatch (Maybe Text)
- pipPayload :: Lens' ProjectsInstancesPatch UpdateInstanceRequest
- pipName :: Lens' ProjectsInstancesPatch Text
- pipCallback :: Lens' ProjectsInstancesPatch (Maybe Text)
REST Resource
type ProjectsInstancesPatchResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] UpdateInstanceRequest :> Patch '[JSON] Operation)))))))) Source #
A resource alias for spanner.projects.instances.patch
method which the
ProjectsInstancesPatch
request conforms to.
Creating a Request
projectsInstancesPatch Source #
Creates a value of ProjectsInstancesPatch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProjectsInstancesPatch Source #
Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on resource name.
See: projectsInstancesPatch
smart constructor.
Instances
Request Lenses
pipUploadProtocol :: Lens' ProjectsInstancesPatch (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
pipAccessToken :: Lens' ProjectsInstancesPatch (Maybe Text) Source #
OAuth access token.
pipUploadType :: Lens' ProjectsInstancesPatch (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
pipPayload :: Lens' ProjectsInstancesPatch UpdateInstanceRequest Source #
Multipart request metadata.
pipName :: Lens' ProjectsInstancesPatch Text Source #
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 6 and 30 characters in length.
pipCallback :: Lens' ProjectsInstancesPatch (Maybe Text) Source #
JSONP