Sign in

v1

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

Updates the parameters of a single Evaluation.

patch/v1/{+name}

Path parameters

namestring required

Name of resource that has the form projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}.

Query parameters

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

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

Request body

customRulesBucketstring

The Cloud Storage bucket name for custom rules.

evaluationType'EVALUATION_TYPE_UNSPECIFIED' | 'SAP' | 'SQL_SERVER' | 'OTHER'

Evaluation type.

createTimestring google-datetime

Output only. [Output only] Create time stamp.

namestring

Name of resource that has the form projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}.

ruleNamesstring[]

The names of the rules used for this evaluation.

labelsobject

Labels as key value pairs.

schedulestring

Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * 0 */1 * * * # Hourly * 0 */6 * * * # Every 6 hours * 0 */12 * * * # Every 12 hours * 0 0 */1 * * # Daily * 0 0 */7 * * # Weekly * 0 0 */14 * * # Every 14 days * 0 0 1 */1 * # Monthly

descriptionstring

Description of the Evaluation.

kmsKeystring

Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/. The key will be used for CMEK encryption of the evaluation resource.

updateTimestring google-datetime

Output only. [Output only] Update time stamp.

Response

Successful response