Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

Updates a cluster in a project.

See: Cloud Dataproc API Reference for dataproc.projects.regions.clusters.patch.

REST Resource

type ProjectsRegionsClustersPatchResource = "v1" :> ("projects" :> (Capture "projectId" Text :> ("regions" :> (Capture "region" Text :> ("clusters" :> (Capture "clusterName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "requestId" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "gracefulDecommissionTimeout" GDuration :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Cluster :> Patch '[JSON] Operation))))))))))))))))

A resource alias for dataproc.projects.regions.clusters.patch method which the ProjectsRegionsClustersPatch request conforms to.

Creating a Request

projectsRegionsClustersPatch

Arguments

:: Cluster

prcpPayload

-> Text

prcpClusterName

-> Text

prcpRegion

-> Text

prcpProjectId

-> ProjectsRegionsClustersPatch

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

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

• prcpXgafv
• prcpRequestId
• prcpUploadProtocol
• prcpUpdateMask
• prcpAccessToken
• prcpUploadType
• prcpPayload
• prcpGracefulDecommissionTimeout
• prcpClusterName
• prcpRegion
• prcpProjectId
• prcpCallback

data ProjectsRegionsClustersPatch

Updates a cluster in a project.

See: projectsRegionsClustersPatch smart constructor.

Instances

Eq ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

Methods

(==) :: ProjectsRegionsClustersPatch -> ProjectsRegionsClustersPatch -> Bool

(/=) :: ProjectsRegionsClustersPatch -> ProjectsRegionsClustersPatch -> Bool

Data ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsRegionsClustersPatch -> c ProjectsRegionsClustersPatch

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsRegionsClustersPatch

toConstr :: ProjectsRegionsClustersPatch -> Constr

dataTypeOf :: ProjectsRegionsClustersPatch -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsRegionsClustersPatch)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsRegionsClustersPatch)

gmapT :: (forall b. Data b => b -> b) -> ProjectsRegionsClustersPatch -> ProjectsRegionsClustersPatch

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRegionsClustersPatch -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRegionsClustersPatch -> r

gmapQ :: (forall d. Data d => d -> u) -> ProjectsRegionsClustersPatch -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsRegionsClustersPatch -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsRegionsClustersPatch -> m ProjectsRegionsClustersPatch

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRegionsClustersPatch -> m ProjectsRegionsClustersPatch

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRegionsClustersPatch -> m ProjectsRegionsClustersPatch

Show ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

Methods

showsPrec :: Int -> ProjectsRegionsClustersPatch -> ShowS

show :: ProjectsRegionsClustersPatch -> String

showList :: [ProjectsRegionsClustersPatch] -> ShowS

Generic ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

Associated Types

type Rep ProjectsRegionsClustersPatch :: Type -> Type

Methods

from :: ProjectsRegionsClustersPatch -> Rep ProjectsRegionsClustersPatch x

to :: Rep ProjectsRegionsClustersPatch x -> ProjectsRegionsClustersPatch

GoogleRequest ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

Associated Types

type Rs ProjectsRegionsClustersPatch :: Type

type Scopes ProjectsRegionsClustersPatch :: [Symbol]

Methods

requestClient :: ProjectsRegionsClustersPatch -> GClient (Rs ProjectsRegionsClustersPatch)

type Rep ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

type Rep ProjectsRegionsClustersPatch = D1 (MetaData "ProjectsRegionsClustersPatch" "Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch" "gogol-dataproc-0.4.0-1udjiqosCX7iHPt6mLpl8" False) (C1 (MetaCons "ProjectsRegionsClustersPatch'" PrefixI True) (((S1 (MetaSel (Just "_prcpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_prcpRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_prcpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_prcpUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :*: (S1 (MetaSel (Just "_prcpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_prcpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_prcpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Cluster) :*: (S1 (MetaSel (Just "_prcpGracefulDecommissionTimeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GDuration)) :*: S1 (MetaSel (Just "_prcpClusterName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: (S1 (MetaSel (Just "_prcpRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_prcpProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_prcpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

type Scopes ProjectsRegionsClustersPatch = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])

type Rs ProjectsRegionsClustersPatch

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Clusters.Patch

type Rs ProjectsRegionsClustersPatch = Operation

Request Lenses

prcpXgafv :: Lens' ProjectsRegionsClustersPatch (Maybe Xgafv)

V1 error format.

prcpRequestId :: Lens' ProjectsRegionsClustersPatch (Maybe Text)

Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

prcpUploadProtocol :: Lens' ProjectsRegionsClustersPatch (Maybe Text)

Upload protocol for media (e.g. "raw", "multipart").

prcpUpdateMask :: Lens' ProjectsRegionsClustersPatch (Maybe GFieldMask)

Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated: > ---------------------------------------------------- ------------------------------- > Mask Purpose > labels Update labels > config.worker_config.num_instances Resize primary worker group > config.secondary_worker_config.num_instances Resize secondary worker group > ---------------------------------------------------- -------------------------------

prcpAccessToken :: Lens' ProjectsRegionsClustersPatch (Maybe Text)

OAuth access token.

prcpUploadType :: Lens' ProjectsRegionsClustersPatch (Maybe Text)

Legacy upload protocol for media (e.g. "media", "multipart").

prcpPayload :: Lens' ProjectsRegionsClustersPatch Cluster

Multipart request metadata.

prcpGracefulDecommissionTimeout :: Lens' ProjectsRegionsClustersPatch (Maybe Scientific)

Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.

prcpClusterName :: Lens' ProjectsRegionsClustersPatch Text

Required. The cluster name.

prcpRegion :: Lens' ProjectsRegionsClustersPatch Text

Required. The Cloud Dataproc region in which to handle the request.

prcpProjectId :: Lens' ProjectsRegionsClustersPatch Text

Required. The ID of the Google Cloud Platform project the cluster belongs to.

prcpCallback :: Lens' ProjectsRegionsClustersPatch (Maybe Text)

JSONP