blob: dea4086018cd88a3a3109bd5118e3f889bd11c87 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudprofiler_v2.html">Stackdriver Profiler API</a> . <a href="cloudprofiler_v2.projects.html">projects</a> . <a href="cloudprofiler_v2.projects.profiles.html">profiles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin".</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#createOffline">createOffline(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">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.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <pre>CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named &quot;google.rpc.retryinfo-bin&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098
99Args:
100 parent: string, Parent project to create the profile in. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102 The object takes the form of:
103
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104{ # CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700105 &quot;profileType&quot;: [ # One or more profile types that the agent is capable of providing.
106 &quot;A String&quot;,
107 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700108 &quot;deployment&quot;: { # Deployment contains the deployment identification information. # Deployment details.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800109 &quot;target&quot;: &quot;A String&quot;, # Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700110 &quot;labels&quot;: { # Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be &lt;= 512 bytes, the total size of all label names and values must be &lt;= 1024 bytes. Label named &quot;language&quot; can be used to record the programming language of the profiled deployment. The standard choices for the value include &quot;java&quot;, &quot;go&quot;, &quot;python&quot;, &quot;ruby&quot;, &quot;nodejs&quot;, &quot;php&quot;, &quot;dotnet&quot;. For deployments running on Google Cloud Platform, &quot;zone&quot; or &quot;region&quot; label should be present describing the deployment location. An example of a zone is &quot;us-central1-a&quot;, an example of a region is &quot;us-central1&quot; or &quot;us-central&quot;.
111 &quot;a_key&quot;: &quot;A String&quot;,
112 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800113 &quot;projectId&quot;: &quot;A String&quot;, # Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700114 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700115 }
116
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122Returns:
123 An object of the form:
124
125 { # Profile resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800126 &quot;profileType&quot;: &quot;A String&quot;, # 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.
127 &quot;labels&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700128 &quot;a_key&quot;: &quot;A String&quot;,
129 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800130 &quot;deployment&quot;: { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.
131 &quot;target&quot;: &quot;A String&quot;, # Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
132 &quot;labels&quot;: { # Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be &lt;= 512 bytes, the total size of all label names and values must be &lt;= 1024 bytes. Label named &quot;language&quot; can be used to record the programming language of the profiled deployment. The standard choices for the value include &quot;java&quot;, &quot;go&quot;, &quot;python&quot;, &quot;ruby&quot;, &quot;nodejs&quot;, &quot;php&quot;, &quot;dotnet&quot;. For deployments running on Google Cloud Platform, &quot;zone&quot; or &quot;region&quot; label should be present describing the deployment location. An example of a zone is &quot;us-central1-a&quot;, an example of a region is &quot;us-central1&quot; or &quot;us-central&quot;.
133 &quot;a_key&quot;: &quot;A String&quot;,
134 },
135 &quot;projectId&quot;: &quot;A String&quot;, # Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.
136 },
137 &quot;profileBytes&quot;: &quot;A String&quot;, # Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.
138 &quot;duration&quot;: &quot;A String&quot;, # 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&#x27;t be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).
139 &quot;name&quot;: &quot;A String&quot;, # Output only. Opaque, server-assigned, unique ID for this profile.
140 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141</div>
142
143<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700144 <code class="details" id="createOffline">createOffline(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 <pre>CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700146
147Args:
148 parent: string, Parent project to create the profile in. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700149 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700150 The object takes the form of:
151
152{ # Profile resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800153 &quot;profileType&quot;: &quot;A String&quot;, # 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.
154 &quot;labels&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 &quot;a_key&quot;: &quot;A String&quot;,
156 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800157 &quot;deployment&quot;: { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.
158 &quot;target&quot;: &quot;A String&quot;, # Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
159 &quot;labels&quot;: { # Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be &lt;= 512 bytes, the total size of all label names and values must be &lt;= 1024 bytes. Label named &quot;language&quot; can be used to record the programming language of the profiled deployment. The standard choices for the value include &quot;java&quot;, &quot;go&quot;, &quot;python&quot;, &quot;ruby&quot;, &quot;nodejs&quot;, &quot;php&quot;, &quot;dotnet&quot;. For deployments running on Google Cloud Platform, &quot;zone&quot; or &quot;region&quot; label should be present describing the deployment location. An example of a zone is &quot;us-central1-a&quot;, an example of a region is &quot;us-central1&quot; or &quot;us-central&quot;.
160 &quot;a_key&quot;: &quot;A String&quot;,
161 },
162 &quot;projectId&quot;: &quot;A String&quot;, # Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.
163 },
164 &quot;profileBytes&quot;: &quot;A String&quot;, # Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.
165 &quot;duration&quot;: &quot;A String&quot;, # 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&#x27;t be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).
166 &quot;name&quot;: &quot;A String&quot;, # Output only. Opaque, server-assigned, unique ID for this profile.
167 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700168
169 x__xgafv: string, V1 error format.
170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
173
174Returns:
175 An object of the form:
176
177 { # Profile resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800178 &quot;profileType&quot;: &quot;A String&quot;, # 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.
179 &quot;labels&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700180 &quot;a_key&quot;: &quot;A String&quot;,
181 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800182 &quot;deployment&quot;: { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.
183 &quot;target&quot;: &quot;A String&quot;, # Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
184 &quot;labels&quot;: { # Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be &lt;= 512 bytes, the total size of all label names and values must be &lt;= 1024 bytes. Label named &quot;language&quot; can be used to record the programming language of the profiled deployment. The standard choices for the value include &quot;java&quot;, &quot;go&quot;, &quot;python&quot;, &quot;ruby&quot;, &quot;nodejs&quot;, &quot;php&quot;, &quot;dotnet&quot;. For deployments running on Google Cloud Platform, &quot;zone&quot; or &quot;region&quot; label should be present describing the deployment location. An example of a zone is &quot;us-central1-a&quot;, an example of a region is &quot;us-central1&quot; or &quot;us-central&quot;.
185 &quot;a_key&quot;: &quot;A String&quot;,
186 },
187 &quot;projectId&quot;: &quot;A String&quot;, # Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.
188 },
189 &quot;profileBytes&quot;: &quot;A String&quot;, # Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.
190 &quot;duration&quot;: &quot;A String&quot;, # 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&#x27;t be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).
191 &quot;name&quot;: &quot;A String&quot;, # Output only. Opaque, server-assigned, unique ID for this profile.
192 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700193</div>
194
195<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700196 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700197 <pre>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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700198
199Args:
200 name: string, Output only. Opaque, server-assigned, unique ID for this profile. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700201 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700202 The object takes the form of:
203
204{ # Profile resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800205 &quot;profileType&quot;: &quot;A String&quot;, # 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.
206 &quot;labels&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 &quot;a_key&quot;: &quot;A String&quot;,
208 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800209 &quot;deployment&quot;: { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.
210 &quot;target&quot;: &quot;A String&quot;, # Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
211 &quot;labels&quot;: { # Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be &lt;= 512 bytes, the total size of all label names and values must be &lt;= 1024 bytes. Label named &quot;language&quot; can be used to record the programming language of the profiled deployment. The standard choices for the value include &quot;java&quot;, &quot;go&quot;, &quot;python&quot;, &quot;ruby&quot;, &quot;nodejs&quot;, &quot;php&quot;, &quot;dotnet&quot;. For deployments running on Google Cloud Platform, &quot;zone&quot; or &quot;region&quot; label should be present describing the deployment location. An example of a zone is &quot;us-central1-a&quot;, an example of a region is &quot;us-central1&quot; or &quot;us-central&quot;.
212 &quot;a_key&quot;: &quot;A String&quot;,
213 },
214 &quot;projectId&quot;: &quot;A String&quot;, # Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.
215 },
216 &quot;profileBytes&quot;: &quot;A String&quot;, # Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.
217 &quot;duration&quot;: &quot;A String&quot;, # 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&#x27;t be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).
218 &quot;name&quot;: &quot;A String&quot;, # Output only. Opaque, server-assigned, unique ID for this profile.
219 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700220
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700221 updateMask: string, 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227Returns:
228 An object of the form:
229
230 { # Profile resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800231 &quot;profileType&quot;: &quot;A String&quot;, # 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.
232 &quot;labels&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700233 &quot;a_key&quot;: &quot;A String&quot;,
234 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800235 &quot;deployment&quot;: { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.
236 &quot;target&quot;: &quot;A String&quot;, # Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
237 &quot;labels&quot;: { # Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be &lt;= 512 bytes, the total size of all label names and values must be &lt;= 1024 bytes. Label named &quot;language&quot; can be used to record the programming language of the profiled deployment. The standard choices for the value include &quot;java&quot;, &quot;go&quot;, &quot;python&quot;, &quot;ruby&quot;, &quot;nodejs&quot;, &quot;php&quot;, &quot;dotnet&quot;. For deployments running on Google Cloud Platform, &quot;zone&quot; or &quot;region&quot; label should be present describing the deployment location. An example of a zone is &quot;us-central1-a&quot;, an example of a region is &quot;us-central1&quot; or &quot;us-central&quot;.
238 &quot;a_key&quot;: &quot;A String&quot;,
239 },
240 &quot;projectId&quot;: &quot;A String&quot;, # Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.
241 },
242 &quot;profileBytes&quot;: &quot;A String&quot;, # Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.
243 &quot;duration&quot;: &quot;A String&quot;, # 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&#x27;t be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).
244 &quot;name&quot;: &quot;A String&quot;, # Output only. Opaque, server-assigned, unique ID for this profile.
245 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246</div>
247
248</body></html>