Debian Codegraph @

docs/dyn/cloudsupport_v2beta.cases.comments.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="cloudsupport_v2beta.html">Google Cloud Support API</a> . <a href="cloudsupport_v2beta.cases.html">cases</a> . <a href="cloudsupport_v2beta.cases.comments.html">comments</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```</p>
83 <p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```</p>
86 <p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
100 <pre>Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case=&quot;projects/some-project/cases/43591344&quot; curl \ --request POST \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ --header &#x27;Content-Type: application/json&#x27; \ --data &#x27;{ &quot;body&quot;: &quot;This is a test comment.&quot; }&#x27; \ &quot;https://cloudsupport.googleapis.com/v2beta/$case/comments&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2beta&quot; supportApiService = googleapiclient.discovery.build( serviceName=&quot;cloudsupport&quot;, version=api_version, discoveryServiceUrl=f&quot;https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}&quot;, ) request = ( supportApiService.cases() .comments() .create( parent=&quot;projects/some-project/cases/43595344&quot;, body={&quot;body&quot;: &quot;This is a test comment.&quot;}, ) ) print(request.execute()) ```
101
102 Args:
103 parent: string, Required. The name of the case to which the comment should be added. (required)
104 body: object, The request body.
105 The object takes the form of:
106
107 { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user&#x27;s responses also appear as comments.
108 &quot;body&quot;: &quot;A String&quot;, # The full comment body. Maximum of 12800 characters.
109 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the comment was created.
110 &quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment.
111 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
112 &quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
113 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
114 &quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
115 },
116 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the comment.
117 &quot;plainTextBody&quot;: &quot;A String&quot;, # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.
118 }
119
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125 Returns:
126 An object of the form:
127
128 { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user&#x27;s responses also appear as comments.
129 &quot;body&quot;: &quot;A String&quot;, # The full comment body. Maximum of 12800 characters.
130 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the comment was created.
131 &quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment.
132 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
133 &quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
134 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
135 &quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
136 },
137 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the comment.
138 &quot;plainTextBody&quot;: &quot;A String&quot;, # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.
139 }</pre>
140 </div>
141
142 <div class="method">
143 <code class="details" id="get">get(name, x__xgafv=None)</code>
144 <pre>Retrieve a comment. EXAMPLES: cURL: ```shell comment=&quot;projects/some-project/cases/43595344/comments/234567890&quot; curl \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ &quot;https://cloudsupport.googleapis.com/v2beta/$comment&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2beta&quot; supportApiService = googleapiclient.discovery.build( serviceName=&quot;cloudsupport&quot;, version=api_version, discoveryServiceUrl=f&quot;https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}&quot;, ) request = supportApiService.cases().comments().get( name=&quot;projects/some-project/cases/43595344/comments/234567890&quot;, ) print(request.execute()) ```
145
146 Args:
147 name: string, Required. The name of the comment to retrieve. (required)
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153 Returns:
154 An object of the form:
155
156 { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user&#x27;s responses also appear as comments.
157 &quot;body&quot;: &quot;A String&quot;, # The full comment body. Maximum of 12800 characters.
158 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the comment was created.
159 &quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment.
160 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
161 &quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
162 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
163 &quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
164 },
165 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the comment.
166 &quot;plainTextBody&quot;: &quot;A String&quot;, # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.
167 }</pre>
168 </div>
169
170 <div class="method">
171 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
172 <pre>List all the comments associated with a case. EXAMPLES: cURL: ```shell case=&quot;projects/some-project/cases/43595344&quot; curl \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ &quot;https://cloudsupport.googleapis.com/v2beta/$case/comments&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2beta&quot; supportApiService = googleapiclient.discovery.build( serviceName=&quot;cloudsupport&quot;, version=api_version, discoveryServiceUrl=f&quot;https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}&quot;, ) request = ( supportApiService.cases() .comments() .list(parent=&quot;projects/some-project/cases/43595344&quot;) ) print(request.execute()) ```
173
174 Args:
175 parent: string, Required. The name of the case for which to list comments. (required)
176 pageSize: integer, The maximum number of comments to fetch. Defaults to 10.
177 pageToken: string, A token identifying the page of results to return. If unspecified, the first page is returned.
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183 Returns:
184 An object of the form:
185
186 { # The response message for the ListComments endpoint.
187 &quot;comments&quot;: [ # List of the comments associated with the case.
188 { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user&#x27;s responses also appear as comments.
189 &quot;body&quot;: &quot;A String&quot;, # The full comment body. Maximum of 12800 characters.
190 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the comment was created.
191 &quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment.
192 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
193 &quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
194 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
195 &quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
196 },
197 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the comment.
198 &quot;plainTextBody&quot;: &quot;A String&quot;, # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.
199 },
200 ],
201 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.comments.list` requests. If unspecified, there are no more results to retrieve.
202 }</pre>
203 </div>
204
205 <div class="method">
206 <code class="details" id="list_next">list_next()</code>
207 <pre>Retrieves the next page of results.
208
209 Args:
210 previous_request: The request for the previous page. (required)
211 previous_response: The response from the request for the previous page. (required)
212
213 Returns:
214 A request object that you can call &#x27;execute()&#x27; on to request the next
215 page. Returns None if there are no more items in the collection.
216 </pre>
217 </div>
218
219 </body></html>