Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the updateMask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
requestId
string
Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.
For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.
The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Request body
The request body contains an instance of Federation.
Response body
If successful, the response body contains an instance of Operation.
[[["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-06-30 UTC."],[[["\u003cp\u003eThis webpage documents the process of updating fields within a federation using a \u003ccode\u003ePATCH\u003c/code\u003e request to the specified endpoint \u003ccode\u003ehttps://metastore.googleapis.com/v1alpha/{federation.name}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe update operation requires the \u003ccode\u003efederation.name\u003c/code\u003e path parameter, indicating the specific federation to be modified, along with a required \u003ccode\u003eupdateMask\u003c/code\u003e query parameter specifying which fields are being changed.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003erequestId\u003c/code\u003e query parameter can be provided for request idempotency, preventing duplicate operations for up to 60 minutes, with each \u003ccode\u003erequestId\u003c/code\u003e being in UUID format.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a \u003ccode\u003eFederation\u003c/code\u003e instance, while a successful response will include an \u003ccode\u003eOperation\u003c/code\u003e instance, reflecting the result of the update.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation necessitates the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e, ensuring that the request is authenticated and authorized to access cloud resources.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.federations.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nUpdates the fields of a federation.\n\n### HTTP request\n\n`PATCH https://metastore.googleapis.com/v1alpha/{federation.name}`\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Federation](/dataproc-metastore/docs/reference/rest/v1alpha/projects.locations.federations#Federation).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/dataproc-metastore/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
