2026-04-02
▼ ▲ alloydb.projects.locations.endpoints.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Description : Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
Type : string
Required : Yes
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Type : string
Location : query
Format : google-fieldmask
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
allowMissing
Description : Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.
Type : boolean
Location : query
validateOnly
Description : Optional. If set, the backend validates the request, but doesn't actually execute it.
Type : boolean
Location : query
Description : Updates the parameters of a single Endpoint.
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
HTTP Method : PATCH
Parameter Order : name
▼ ▲ alloydb.projects.locations.endpoints.delete
Description : Deletes a single Endpoint.
Parameters :
name
Required : Yes
Description : Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
etag
Location : query
Description : Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.
Type : string
validateOnly
Description : Optional. If set, the backend validates the request, but doesn't actually execute it.
Type : boolean
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
▼ ▲ alloydb.projects.locations.endpoints.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single Endpoint.
Parameters :
name
Description : Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Path : v1beta/{+name}
Parameter Order : name
HTTP Method : GET
▼ ▲ alloydb.projects.locations.endpoints.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Endpoints in a given project and location.
Parameters :
orderBy
Description : Optional. Hint for how to order the results
Type : string
Location : query
filter
Location : query
Description : Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
Type : string
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-
Type : string
pageToken
Location : query
Description : Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
Type : string
pageSize
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/endpoints
Path : v1beta/{+parent}/endpoints
Parameter Order : parent
HTTP Method : GET
▼ ▲ alloydb.projects.locations.endpoints.create
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/endpoints
Path : v1beta/{+parent}/endpoints
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
Type : string
endpointId
Location : query
Description : Required. ID of the requesting object.
Type : string
validateOnly
Description : Optional. If set, the backend validates the request, but doesn't actually execute it.
Type : boolean
Location : query
Description : Creates a new Endpoint in a given project and location.