Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13214471.4 KB
projects

Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.

patch/v1/{+name}

Path parameters

namestring required

Identifier. The relative resource name of the schema, in the format: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Right now, the only supported schema is "main".

Query parameters

allowMissingboolean

Optional. If true and the Schema is not found, a new Schema will be created. In this case, update_mask is ignored.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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 original operation with the same request ID was received, and if so, will ignore 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).

updateMaskstring

Optional. Field mask is used to specify the fields to be overwritten in the Schema 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.

validateOnlyboolean

Optional. If set, validate the request and preview the Schema, but do not actually update it.

Request body

createTimestring google-datetime

Output only. [Output only] Create time stamp.

uidstring

Output only. System-assigned, unique identifier.

namestring

Identifier. The relative resource name of the schema, in the format: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Right now, the only supported schema is "main".

labelsobject

Optional. Labels as key value pairs.

etagstring

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. AIP-154

annotationsobject

Optional. Stores small amounts of arbitrary data.

updateTimestring google-datetime

Output only. [Output only] Update time stamp.

reconcilingboolean

Output only. A field that if true, indicates that the system is working to compile and deploy the schema.

displayNamestring

Optional. Mutable human-readable name. 63 character limit.

Response

Successful response