Sign in

v1

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

UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation. Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection.

patch/v2/{+name}

Path parameters

namestring required

Output only. Opaque, server-assigned, unique ID for this profile.

Query parameters

updateMaskstring

Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten.

Request body

labelsobject

Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

startTimestring google-datetime

Output only. Start time for the profile. This output is only present in response from the ListProfiles method.

profileType'PROFILE_TYPE_UNSPECIFIED' | 'CPU' | 'WALL' | 'HEAP' | 'THREADS' | 'CONTENTION' | 'PEAK_HEAP' | 'HEAP_ALLOC'

Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server.

profileBytesstring byte

Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.

durationstring google-duration

Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).

namestring

Output only. Opaque, server-assigned, unique ID for this profile.

Response

Successful response

All 4 operations