Debian Codegraph @

docs/dyn/cloudsupport_v2.cases.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_v2.html">Google Cloud Support API</a> . <a href="cloudsupport_v2.cases.html">cases</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="cloudsupport_v2.cases.attachments.html">attachments()</a></code>
79 </p>
80 <p class="firstline">Returns the attachments Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="cloudsupport_v2.cases.comments.html">comments()</a></code>
84 </p>
85 <p class="firstline">Returns the comments Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close(name, body=None, x__xgafv=None)</a></code></p>
89 <p class="firstline">Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```</p>
90 <p class="toc_element">
91 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
92 <p class="firstline">Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "[email protected]", "[email protected]" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```</p>
93 <p class="toc_element">
94 <code><a href="#escalate">escalate(name, body=None, x__xgafv=None)</a></code></p>
95 <p class="firstline">Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```</p>
96 <p class="toc_element">
97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
98 <p class="firstline">Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```</p>
99 <p class="toc_element">
100 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
101 <p class="firstline">Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```</p>
102 <p class="toc_element">
103 <code><a href="#list_next">list_next()</a></code></p>
104 <p class="firstline">Retrieves the next page of results.</p>
105 <p class="toc_element">
106 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
107 <p class="firstline">Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```</p>
108 <p class="toc_element">
109 <code><a href="#search">search(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
110 <p class="firstline">Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```</p>
111 <p class="toc_element">
112 <code><a href="#search_next">search_next()</a></code></p>
113 <p class="firstline">Retrieves the next page of results.</p>
114 <h3>Method Details</h3>
115 <div class="method">
116 <code class="details" id="close">close(name, body=None, x__xgafv=None)</code>
117 <pre>Close a case. EXAMPLES: cURL: ```shell case=&quot;projects/some-project/cases/43595344&quot; curl \ --request POST \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ &quot;https://cloudsupport.googleapis.com/v2/$case:close&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2&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().close( name=&quot;projects/some-project/cases/43595344&quot; ) print(request.execute()) ```
118
119 Args:
120 name: string, Required. The name of the case to close. (required)
121 body: object, The request body.
122 The object takes the form of:
123
124 { # The request message for the CloseCase endpoint.
125 }
126
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132 Returns:
133 An object of the form:
134
135 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
136 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
137 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
138 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
139 },
140 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
141 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
142 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
143 &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.
144 &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.
145 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
146 &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.
147 },
148 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
149 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
150 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
151 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
152 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
153 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
154 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
155 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
156 &quot;A String&quot;,
157 ],
158 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
159 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
160 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
161 }</pre>
162 </div>
163
164 <div class="method">
165 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
166 <pre>Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you&#x27;re just testing the API and don&#x27;t want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent=&quot;projects/some-project&quot; curl \ --request POST \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ --header &#x27;Content-Type: application/json&#x27; \ --data &#x27;{ &quot;display_name&quot;: &quot;Test case created by me.&quot;, &quot;description&quot;: &quot;a random test case, feel free to close&quot;, &quot;classification&quot;: { &quot;id&quot;: &quot;100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8&quot; }, &quot;time_zone&quot;: &quot;-07:00&quot;, &quot;subscriber_email_addresses&quot;: [ &quot;[email protected]&quot;, &quot;[email protected]&quot; ], &quot;testCase&quot;: true, &quot;priority&quot;: &quot;P3&quot; }&#x27; \ &quot;https://cloudsupport.googleapis.com/v2/$parent/cases&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2&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().create( parent=&quot;projects/some-project&quot;, body={ &quot;displayName&quot;: &quot;A Test Case&quot;, &quot;description&quot;: &quot;This is a test case.&quot;, &quot;testCase&quot;: True, &quot;priority&quot;: &quot;P2&quot;, &quot;classification&quot;: { &quot;id&quot;: &quot;100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8&quot; }, }, ) print(request.execute()) ```
167
168 Args:
169 parent: string, Required. The name of the parent under which the case should be created. (required)
170 body: object, The request body.
171 The object takes the form of:
172
173 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
174 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
175 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
176 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
177 },
178 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
179 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
180 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
181 &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.
182 &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.
183 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
184 &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.
185 },
186 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
187 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
188 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
189 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
190 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
191 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
192 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
193 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
194 &quot;A String&quot;,
195 ],
196 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
197 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
198 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
199 }
200
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206 Returns:
207 An object of the form:
208
209 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
210 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
211 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
212 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
213 },
214 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
215 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
216 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
217 &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.
218 &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.
219 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
220 &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.
221 },
222 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
223 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
224 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
225 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
226 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
227 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
228 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
229 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
230 &quot;A String&quot;,
231 ],
232 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
233 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
234 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
235 }</pre>
236 </div>
237
238 <div class="method">
239 <code class="details" id="escalate">escalate(name, body=None, x__xgafv=None)</code>
240 <pre>Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for &#x27;Technical support escalations&#x27; in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case=&quot;projects/some-project/cases/43595344&quot; curl \ --request POST \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ --header &quot;Content-Type: application/json&quot; \ --data &#x27;{ &quot;escalation&quot;: { &quot;reason&quot;: &quot;BUSINESS_IMPACT&quot;, &quot;justification&quot;: &quot;This is a test escalation.&quot; } }&#x27; \ &quot;https://cloudsupport.googleapis.com/v2/$case:escalate&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2&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().escalate( name=&quot;projects/some-project/cases/43595344&quot;, body={ &quot;escalation&quot;: { &quot;reason&quot;: &quot;BUSINESS_IMPACT&quot;, &quot;justification&quot;: &quot;This is a test escalation.&quot;, }, }, ) print(request.execute()) ```
241
242 Args:
243 name: string, Required. The name of the case to be escalated. (required)
244 body: object, The request body.
245 The object takes the form of:
246
247 { # The request message for the EscalateCase endpoint.
248 &quot;escalation&quot;: { # An escalation of a support case. # The escalation information to be sent with the escalation request.
249 &quot;justification&quot;: &quot;A String&quot;, # Required. A free text description to accompany the `reason` field above. Provides additional context on why the case is being escalated.
250 &quot;reason&quot;: &quot;A String&quot;, # Required. The reason why the Case is being escalated.
251 },
252 }
253
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259 Returns:
260 An object of the form:
261
262 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
263 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
264 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
265 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
266 },
267 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
268 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
269 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
270 &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.
271 &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.
272 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
273 &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.
274 },
275 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
276 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
277 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
278 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
279 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
280 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
281 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
282 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
283 &quot;A String&quot;,
284 ],
285 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
286 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
287 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
288 }</pre>
289 </div>
290
291 <div class="method">
292 <code class="details" id="get">get(name, x__xgafv=None)</code>
293 <pre>Retrieve a case. EXAMPLES: cURL: ```shell case=&quot;projects/some-project/cases/16033687&quot; curl \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ &quot;https://cloudsupport.googleapis.com/v2/$case&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2&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().get( name=&quot;projects/some-project/cases/43595344&quot;, ) print(request.execute()) ```
294
295 Args:
296 name: string, Required. The full name of a case to be retrieved. (required)
297 x__xgafv: string, V1 error format.
298 Allowed values
299 1 - v1 error format
300 2 - v2 error format
301
302 Returns:
303 An object of the form:
304
305 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
306 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
307 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
308 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
309 },
310 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
311 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
312 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
313 &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.
314 &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.
315 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
316 &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.
317 },
318 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
319 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
320 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
321 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
322 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
323 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
324 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
325 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
326 &quot;A String&quot;,
327 ],
328 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
329 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
330 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
331 }</pre>
332 </div>
333
334 <div class="method">
335 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
336 <pre>Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent=&quot;projects/some-project&quot; curl \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ &quot;https://cloudsupport.googleapis.com/v2/$parent/cases&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2&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().list(parent=&quot;projects/some-project&quot;) print(request.execute()) ```
337
338 Args:
339 parent: string, Required. The name of a parent to list cases under. (required)
340 filter: string, An expression used to filter cases. If it&#x27;s an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. EXAMPLES: - `state=CLOSED` - `state=OPEN AND creator.email=&quot;[email protected]&quot;` - `state=OPEN AND (priority=P0 OR priority=P1)`
341 pageSize: integer, The maximum number of cases fetched with each request. Defaults to 10.
342 pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved.
343 x__xgafv: string, V1 error format.
344 Allowed values
345 1 - v1 error format
346 2 - v2 error format
347
348 Returns:
349 An object of the form:
350
351 { # The response message for the ListCases endpoint.
352 &quot;cases&quot;: [ # The list of cases associated with the parent after any filters have been applied.
353 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
354 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
355 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
356 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
357 },
358 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
359 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
360 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
361 &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.
362 &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.
363 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
364 &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.
365 },
366 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
367 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
368 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
369 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
370 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
371 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
372 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
373 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
374 &quot;A String&quot;,
375 ],
376 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
377 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
378 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
379 },
380 ],
381 &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.list` requests. If unspecified, there are no more results to retrieve.
382 }</pre>
383 </div>
384
385 <div class="method">
386 <code class="details" id="list_next">list_next()</code>
387 <pre>Retrieves the next page of results.
388
389 Args:
390 previous_request: The request for the previous page. (required)
391 previous_response: The response from the request for the previous page. (required)
392
393 Returns:
394 A request object that you can call &#x27;execute()&#x27; on to request the next
395 page. Returns None if there are no more items in the collection.
396 </pre>
397 </div>
398
399 <div class="method">
400 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
401 <pre>Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case=&quot;projects/some-project/cases/43595344&quot; curl \ --request PATCH \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ --header &quot;Content-Type: application/json&quot; \ --data &#x27;{ &quot;priority&quot;: &quot;P1&quot; }&#x27; \ &quot;https://cloudsupport.googleapis.com/v2/$case?updateMask=priority&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2&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().patch( name=&quot;projects/some-project/cases/43112854&quot;, body={ &quot;displayName&quot;: &quot;This is Now a New Title&quot;, &quot;priority&quot;: &quot;P2&quot;, }, ) print(request.execute()) ```
402
403 Args:
404 name: string, Identifier. The resource name for the case. (required)
405 body: object, The request body.
406 The object takes the form of:
407
408 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
409 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
410 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
411 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
412 },
413 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
414 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
415 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
416 &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.
417 &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.
418 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
419 &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.
420 },
421 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
422 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
423 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
424 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
425 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
426 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
427 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
428 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
429 &quot;A String&quot;,
430 ],
431 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
432 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
433 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
434 }
435
436 updateMask: string, A list of attributes of the case that should be updated. Supported values are `priority`, `display_name`, and `subscriber_email_addresses`. If no fields are specified, all supported fields are updated. Be careful - if you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for `subscriber_email_addresses`, then `subscriber_email_addresses` is updated to empty.
437 x__xgafv: string, V1 error format.
438 Allowed values
439 1 - v1 error format
440 2 - v2 error format
441
442 Returns:
443 An object of the form:
444
445 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
446 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
447 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
448 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
449 },
450 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
451 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
452 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
453 &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.
454 &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.
455 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
456 &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.
457 },
458 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
459 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
460 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
461 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
462 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
463 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
464 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
465 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
466 &quot;A String&quot;,
467 ],
468 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
469 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
470 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
471 }</pre>
472 </div>
473
474 <div class="method">
475 <code class="details" id="search">search(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code>
476 <pre>Search for cases using a query. EXAMPLES: cURL: ```shell parent=&quot;projects/some-project&quot; curl \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ &quot;https://cloudsupport.googleapis.com/v2/$parent/cases:search&quot; ``` Python: ```python import googleapiclient.discovery api_version = &quot;v2&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().search( parent=&quot;projects/some-project&quot;, query=&quot;state=OPEN&quot; ) print(request.execute()) ```
477
478 Args:
479 parent: string, The name of the parent resource to search for cases under. (required)
480 pageSize: integer, The maximum number of cases fetched with each request. The default page size is 10.
481 pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved.
482 query: string, An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `&quot;my search&quot;`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time&gt;&quot;2020-01-01T00:00:00-05:00&quot;`. `update_time` only supports the greater than operator (`&gt;`). If you are using the `v2` version of the API, you must specify the case parent in the `parent` field. If you provide an empty `query`, all cases under the parent resource will be returned. If you are using the `v2beta` version of the API, you must specify the case parent in the `query` field using one of the two fields below, which are only available for `v2beta`. The `parent` field will be ignored. - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. Examples: For `v2`: - `state=CLOSED` - `state=OPEN AND creator.email=&quot;[email protected]&quot;` - `state=OPEN AND (priority=P0 OR priority=P1)` - `update_time&gt;&quot;2020-01-01T00:00:00-05:00&quot;` For `v2beta`: - `organization=&quot;organizations/123456789&quot;` - `project=&quot;projects/my-project-id&quot;` - `project=&quot;projects/123456789&quot;` - `organization=&quot;organizations/123456789&quot; AND state=CLOSED` - `project=&quot;projects/my-project-id&quot; AND creator.email=&quot;[email protected]&quot;` - `project=&quot;projects/my-project-id&quot; AND (priority=P0 OR priority=P1)`
483 x__xgafv: string, V1 error format.
484 Allowed values
485 1 - v1 error format
486 2 - v2 error format
487
488 Returns:
489 An object of the form:
490
491 { # The response message for the SearchCases endpoint.
492 &quot;cases&quot;: [ # The list of cases associated with the parent after any filters have been applied.
493 { # A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
494 &quot;classification&quot;: { # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;re used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case. # The issue classification applicable to this case.
495 &quot;displayName&quot;: &quot;A String&quot;, # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.
496 &quot;id&quot;: &quot;A String&quot;, # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
497 },
498 &quot;contactEmail&quot;: &quot;A String&quot;, # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user&#x27;s email address directly from their EUCs.
499 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this case was created.
500 &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. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
501 &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.
502 &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.
503 &quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
504 &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.
505 },
506 &quot;description&quot;: &quot;A String&quot;, # A broad description of the issue.
507 &quot;displayName&quot;: &quot;A String&quot;, # The short summary of the issue reported in this case.
508 &quot;escalated&quot;: True or False, # Whether the case is currently escalated.
509 &quot;languageCode&quot;: &quot;A String&quot;, # The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `&quot;en&quot;`, `&quot;zh-CN&quot;`, `&quot;zh-TW&quot;`, `&quot;ja&quot;`, `&quot;ko&quot;`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
510 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the case.
511 &quot;priority&quot;: &quot;A String&quot;, # The priority of this case.
512 &quot;state&quot;: &quot;A String&quot;, # Output only. The current status of the support case.
513 &quot;subscriberEmailAddresses&quot;: [ # The email addresses to receive updates on this case.
514 &quot;A String&quot;,
515 ],
516 &quot;testCase&quot;: True or False, # Whether this case was created for internal API testing and should not be acted on by the support team.
517 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
518 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this case was last updated.
519 },
520 ],
521 &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.search` requests. If unspecified, there are no more results to retrieve.
522 }</pre>
523 </div>
524
525 <div class="method">
526 <code class="details" id="search_next">search_next()</code>
527 <pre>Retrieves the next page of results.
528
529 Args:
530 previous_request: The request for the previous page. (required)
531 previous_response: The response from the request for the previous page. (required)
532
533 Returns:
534 A request object that you can call &#x27;execute()&#x27; on to request the next
535 page. Returns None if there are no more items in the collection.
536 </pre>
537 </div>
538
539 </body></html>