Debian Codegraph @

docs/dyn/cloudsupport_v2beta.caseClassifications.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.caseClassifications.html">caseClassifications</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="#search">search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2beta/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2beta", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```</p>
83 <p class="toc_element">
84 <code><a href="#search_next">search_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="search">search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None)</code>
94 <pre>Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `&quot; &gt; &quot;`. For example, `&quot;Technical Issue &gt; Compute &gt; Compute Engine&quot;`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header &quot;Authorization: Bearer $(gcloud auth print-access-token)&quot; \ &#x27;https://cloudsupport.googleapis.com/v2beta/caseClassifications:search?query=display_name:&quot;*Compute%20Engine*&quot;&#x27; ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName=&quot;cloudsupport&quot;, version=&quot;v2beta&quot;, discoveryServiceUrl=f&quot;https://cloudsupport.googleapis.com/$discovery/rest?version=v2&quot;, ) request = supportApiService.caseClassifications().search( query=&#x27;display_name:&quot;*Compute Engine*&quot;&#x27; ) print(request.execute()) ```
95
96 Args:
97 pageSize: integer, The maximum number of classifications fetched with each request.
98 pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved.
99 product_productLine: string, The product line of the Product.
100 Allowed values
101 PRODUCT_LINE_UNSPECIFIED - Unknown product type.
102 GOOGLE_CLOUD - Google Cloud
103 GOOGLE_MAPS - Google Maps
104 query: string, An expression used to filter case classifications. If it&#x27;s an empty string, then no filtering happens. Otherwise, case classifications will be returned that match the filter.
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110 Returns:
111 An object of the form:
112
113 { # The response message for SearchCaseClassifications endpoint.
114 &quot;caseClassifications&quot;: [ # The classifications retrieved.
115 { # 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.
116 &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.
117 &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.
118 &quot;product&quot;: { # The product a case may be associated with. # The full product the classification corresponds to.
119 &quot;productLine&quot;: &quot;A String&quot;, # The product line of the Product.
120 },
121 },
122 ],
123 &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 `caseClassifications.list` requests. If unspecified, there are no more results to retrieve.
124 }</pre>
125 </div>
126
127 <div class="method">
128 <code class="details" id="search_next">search_next()</code>
129 <pre>Retrieves the next page of results.
130
131 Args:
132 previous_request: The request for the previous page. (required)
133 previous_response: The response from the request for the previous page. (required)
134
135 Returns:
136 A request object that you can call &#x27;execute()&#x27; on to request the next
137 page. Returns None if there are no more items in the collection.
138 </pre>
139 </div>
140
141 </body></html>