2022-07-26
▼ ▲ gameservices.projects.locations.gameServerDeployments.create
Parameters:
deploymentId
Location: query
Description: Required. The ID of the game server deployment resource to create.
Type: string
parent
Required: Yes
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: POST
Description: Creates a new game server deployment in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments
Parameter Order: parent
Path: v1/{+parent}/gameServerDeployments
▼ ▲ gameservices.projects.locations.gameServerDeployments.list
Path: v1/{+parent}/gameServerDeployments
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments
Description: Lists game server deployments in a given project and location.
Parameter Order: parent
HTTP Method: GET
Parameters:
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.
orderBy
Type: string
Location: query
Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
pageToken
Description: Optional. The next_page_token value returned from a previous list request, if any.
Location: query
Type: string
pageSize
Location: query
Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on the response's next_page_token to determine if there are more GameServerDeployments left to be queried.
Format: int32
Type: integer
filter
Location: query
Type: string
Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).
▼ ▲ gameservices.projects.locations.gameServerDeployments.previewRollout
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Previews the game server deployment rollout. This API does not mutate the rollout resource.
Parameters:
updateMask
Location: query
Format: google-fieldmask
Description: Optional. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Type: string
previewTime
Format: google-datetime
Description: Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.
Type: string
Location: query
name
Required: Yes
Location: path
Description: The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout:preview
HTTP Method: PATCH
Parameter Order: name
Path: v1/{+name}/rollout:preview
▼ ▲ gameservices.projects.locations.gameServerDeployments.patch
Description: Patches a game server deployment.
HTTP Method: PATCH
Parameters:
name
Location: path
Type: string
Description: The resource name of the game server deployment, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Required: Yes
updateMask
Format: google-fieldmask
Description: Required. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}
Parameter Order: name
Path: v1/{+name}
▼ ▲ gameservices.projects.locations.gameServerDeployments.delete
Path: v1/{+name}
Description: Deletes a single game server deployment.
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Description: Required. The name of the game server deployment to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.
Required: Yes
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}
HTTP Method: DELETE
▼ ▲ gameservices.projects.locations.gameServerDeployments.fetchDeploymentState
HTTP Method: POST
Path: v1/{+name}:fetchDeploymentState
Parameters:
name
Description: Required. The name of the game server deployment, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:fetchDeploymentState
Description: Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ gameservices.projects.locations.gameServerDeployments.updateRollout
Path: v1/{+name}/rollout
Description: Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example, the following cases will not return an error: * The default_game_server_config is changed but all existing realms use the override. * A non-existing realm is explicitly called out in the game_server_config_overrides field.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Type: string
Required: Yes
Location: path
Description: The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.
updateMask
Type: string
Format: google-fieldmask
Description: Required. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Location: query
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout
▼ ▲ gameservices.projects.locations.gameServerDeployments.getRollout
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Gets details of a single game server deployment rollout.
Path: v1/{+name}/rollout
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout
Parameters:
name
Type: string
Location: path
Description: Required. The name of the game server deployment rollout to retrieve, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/rollout`.
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Required: Yes
▼ ▲ gameservices.projects.locations.gameServerDeployments.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}
Description: Gets details of a single game server deployment.
Path: v1/{+name}
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Description: Required. The name of the game server deployment to retrieve, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.
Required: Yes
Parameter Order: name
▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.create
Description: Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
configId
Description: Required. The ID of the game server config resource to create.
Type: string
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/`.
Type: string
Location: path
Required: Yes
HTTP Method: POST
Path: v1/{+parent}/configs
▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.get
Description: Gets details of a single game server config.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Required: Yes
Type: string
Description: Required. The name of the game server config to retrieve, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs/{configsId}
Parameter Order: name
Path: v1/{+name}
▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.list
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs
Description: Lists game server configs in a given project, location, and game server deployment.
Path: v1/{+parent}/configs
Parameters:
parent
Required: Yes
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/*`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$
Location: path
filter
Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).
Type: string
Location: query
orderBy
Type: string
Location: query
Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
pageSize
Type: integer
Format: int32
Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerConfigs left to be queried.
Location: query
pageToken
Type: string
Description: Optional. The next_page_token value returned from a previous list request, if any.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.delete
Parameters:
name
Description: Required. The name of the game server config to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$
Required: Yes
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single game server config. The deletion fails if the game server config is referenced in a game server deployment rollout.
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs/{configsId}
Parameter Order: name
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.get
Description: Gets details of a single game server cluster.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}
Path: v1/{+name}
HTTP Method: GET
Parameters:
name
Required: Yes
Description: Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$
Location: path
view
Location: query
Enum:
Description: Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is `GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED`, the same as `BASIC`, which does not return the `cluster_state` field.
Type: string
Enum Descriptions:
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.previewUpdate
Description: Previews updating a GameServerCluster.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}:previewUpdate
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Type: string
Description: Required. Mask of fields to update. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Format: google-fieldmask
Location: query
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$
Description: Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
Required: Yes
Type: string
previewTime
Description: Optional. The target timestamp to compute the preview.
Type: string
Format: google-datetime
Location: query
Path: v1/{+name}:previewUpdate
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.delete
HTTP Method: DELETE
Description: Deletes a single game server cluster.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$
Required: Yes
Description: Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerClusters/{gameServerClusterId}`.
Location: path
Type: string
Parameter Order: name
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters
Description: Creates a new game server cluster in a given project and location.
HTTP Method: POST
Parameter Order: parent
Parameters:
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.
gameServerClusterId
Location: query
Type: string
Description: Required. The ID of the game server cluster resource to create.
Path: v1/{+parent}/gameServerClusters
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.previewCreate
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
previewTime
Location: query
Format: google-datetime
Description: Optional. The target timestamp to compute the preview.
Type: string
gameServerClusterId
Type: string
Location: query
Description: Required. The ID of the game server cluster resource to create.
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Required: Yes
Location: path
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.
view
Enum Descriptions:
Location: query
Type: string
Enum:
Description: Optional. This field is deprecated. Preview will always return KubernetesClusterState.
Path: v1/{+parent}/gameServerClusters:previewCreate
Parameter Order: parent
HTTP Method: POST
Description: Previews creation of a new game server cluster in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters:previewCreate
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.patch
HTTP Method: PATCH
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
updateMask
Description: Required. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Type: string
Format: google-fieldmask
Location: query
Description: Patches a single game server cluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}
Path: v1/{+name}
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.list
Path: v1/{+parent}/gameServerClusters
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters
Parameters:
view
Description: Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is `GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED`, the same as `BASIC`, which does not return the `cluster_state` field.
Location: query
Enum:
Type: string
Enum Descriptions:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.
Type: string
Required: Yes
Location: path
pageSize
Format: int32
Location: query
Type: integer
Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.
filter
Location: query
Type: string
Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).
orderBy
Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
Location: query
Type: string
pageToken
Type: string
Description: Optional. The next_page_token value returned from a previous list request, if any.
Location: query
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists game server clusters in a given project and location.
▼ ▲ gameservices.projects.locations.realms.gameServerClusters.previewDelete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}:previewDelete
Description: Previews deletion of a single game server cluster.
HTTP Method: DELETE
Parameter Order: name
Path: v1/{+name}:previewDelete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
previewTime
Type: string
Location: query
Format: google-datetime
Description: Optional. The target timestamp to compute the preview.
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$
Description: Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerClusters/{gameServerClusterId}`.
Type: string
Required: Yes
▼ ▲ gameservices.projects.locations.realms.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}
Description: Gets details of a single realm.
HTTP Method: GET
Path: v1/{+name}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Description: Required. The name of the realm to retrieve, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ gameservices.projects.locations.realms.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
Description: Creates a new realm in a given project and location.
Parameters:
realmId
Description: Required. The ID of the realm resource to create.
Type: string
Location: query
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.
Path: v1/{+parent}/realms
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms
▼ ▲ gameservices.projects.locations.realms.delete
Parameter Order: name
HTTP Method: DELETE
Description: Deletes a single realm.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Required: Yes
Description: Required. The name of the realm to delete, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.
Path: v1/{+name}
▼ ▲ gameservices.projects.locations.realms.list
HTTP Method: GET
Parameter Order: parent
Description: Lists realms in a given project and location.
Parameters:
pageToken
Description: Optional. The next_page_token value returned from a previous list request, if any.
Location: query
Type: string
orderBy
Type: string
Location: query
Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
parent
Type: string
Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
filter
Type: string
Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).
Location: query
pageSize
Location: query
Type: integer
Format: int32
Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on the response's next_page_token to determine if there are more realms left to be queried.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms
Path: v1/{+parent}/realms
▼ ▲ gameservices.projects.locations.realms.previewUpdate
Description: Previews patches to a single realm.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}:previewUpdate
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:previewUpdate
Parameters:
name
Required: Yes
Description: The resource name of the realm, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`. For example, `projects/my-project/locations/global/realms/my-realm`.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
updateMask
Format: google-fieldmask
Type: string
Description: Required. The update mask to apply to the resource. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Location: query
previewTime
Location: query
Format: google-datetime
Description: Optional. The target timestamp to compute the preview.
Type: string
HTTP Method: PATCH
Parameter Order: name
▼ ▲ gameservices.projects.locations.realms.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}
Description: Patches a single realm.
Parameter Order: name
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Type: string
Description: Required. The update mask to apply to the resource. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Format: google-fieldmask
Location: query
name
Type: string
Location: path
Description: The resource name of the realm, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`. For example, `projects/my-project/locations/global/realms/my-realm`.
Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Required: Yes