Stay organized with collections
Save and categorize content based on your preferences.
Updates an instance partition, and begins allocating or releasing
resources as requested. The returned long-running operation can be used
to track the progress of updating the instance partition. If the named
instance partition does not exist, returns NOT_FOUND. Immediately upon
completion of this request: * For resource types for which a decrease in
the instance partition'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 partition are rejected. * Reading the
instance partition 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 partition's tables. * The instance
partition'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 partition modification. The metadata
field type is UpdateInstancePartitionMetadata. The response field type
is InstancePartition, if successful. Authorization requires
spanner.instancePartitions.update permission on the resource name.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800 seconds (30
minutes) and can be changed to a maximum value of 31536000 seconds (one year)
for long-running operations using the connector_params field.
The connector uses polling to monitor the long-running operation, which might
generate additional billable steps. The polling policy for the long-running
operation can be configured. For example, if you set skip_polling to True,
the connector invocation call is non-blocking if the initial request succeeds;
otherwise, retries might occur.
For more information about connector-specific parameters (connector_params),
see Invoke a connector call.
For more information about retries and long-running operations, see
Understand connectors.
Arguments
Parameters
name
string
Required. A unique identifier for the instance partition. Values are of the form projects//instances//instancePartitions/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Method: googleapis.spanner.v1.projects.instances.instancePartitions.patch\n\nUpdates an instance partition, and begins allocating or releasing\nresources as requested. The returned long-running operation can be used\nto track the progress of updating the instance partition. If the named\ninstance partition does not exist, returns `NOT_FOUND`. Immediately upon\ncompletion of this request: \\* For resource types for which a decrease in\nthe instance partition's allocation has been requested, billing is based\non the newly-requested level. Until completion of the returned\noperation: \\* Cancelling the operation sets its metadata's cancel_time,\nand begins restoring resources to their pre-request values. The\noperation is guaranteed to succeed at undoing all resource changes,\nafter which point it terminates with a `CANCELLED` status. \\* All other\nattempts to modify the instance partition are rejected. \\* Reading the\ninstance partition via the API continues to give the pre-request\nresource levels. Upon completion of the returned operation: \\* Billing\nbegins for all successfully-allocated resources (some types may have\nlower than the requested levels). \\* All newly-reserved resources are\navailable for serving the instance partition's tables. \\* The instance\npartition's new resource levels are readable via the API. The returned\nlong-running operation will have a name of the format `/operations/` and\ncan be used to track the instance partition modification. The metadata\nfield type is UpdateInstancePartitionMetadata. The response field type\nis InstancePartition, if successful. Authorization requires\n`spanner.instancePartitions.update` permission on the resource name.\n\nThis method waits---the workflow execution is paused---until the operation is\ncomplete, fails, or times out. The default timeout value is `1800` seconds (30\nminutes) and can be changed to a maximum value of `31536000` seconds (one year)\nfor long-running operations using the `connector_params` field.\n\nThe connector uses polling to monitor the long-running operation, which might\ngenerate additional billable steps. The polling policy for the long-running\noperation can be configured. For example, if you set `skip_polling` to `True`,\nthe connector invocation call is non-blocking if the initial request succeeds;\notherwise, retries might occur.\n\nFor more information about connector-specific parameters (`connector_params`),\nsee [Invoke a connector call](/workflows/docs/reference/googleapis#invoke_a_connector_call).\n\nFor more information about retries and long-running operations, see\n[Understand connectors](/workflows/docs/connectors).\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`Operation`](https://cloud.google.com/workflows/docs/reference/googleapis/spanner/v1/Overview#Operation).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instances.instancePartitions/patch). \n\n### YAML\n\n```yaml\n- patch:\n call: googleapis.spanner.v1.projects.instances.instancePartitions.patch\n args:\n name: ...\n body:\n fieldMask: ...\n instancePartition:\n config: ...\n displayName: ...\n etag: ...\n name: ...\n nodeCount: ...\n processingUnits: ...\n result: patchResult\n```\n\n### JSON\n\n```json\n[\n {\n \"patch\": {\n \"call\": \"googleapis.spanner.v1.projects.instances.instancePartitions.patch\",\n \"args\": {\n \"name\": \"...\",\n \"body\": {\n \"fieldMask\": \"...\",\n \"instancePartition\": {\n \"config\": \"...\",\n \"displayName\": \"...\",\n \"etag\": \"...\",\n \"name\": \"...\",\n \"nodeCount\": \"...\",\n \"processingUnits\": \"...\"\n }\n }\n },\n \"result\": \"patchResult\"\n }\n }\n]\n```"]]