blob: 94a83a4556fdb717e4f97a7697998ad901a7fb10 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudsupport_v2beta.html">Google Cloud Support API</a> . <a href="cloudsupport_v2beta.caseClassifications.html">caseClassifications</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#search">search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None)</a></code></p>
<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/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```</p>
<p class="toc_element">
<code><a href="#search_next">search_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="search">search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None)</code>
<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/v2/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;v2&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()) ```
Args:
pageSize: integer, The maximum number of classifications fetched with each request.
pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved.
product_productLine: string, The product line of the Product.
Allowed values
PRODUCT_LINE_UNSPECIFIED - Unknown product type.
GOOGLE_CLOUD - Google Cloud
GOOGLE_MAPS - Google Maps
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for SearchCaseClassifications endpoint.
&quot;caseClassifications&quot;: [ # The classifications retrieved.
{ # 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.
&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.
&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.
&quot;product&quot;: { # The product a case may be associated with. # The full product the classification corresponds to.
&quot;productLine&quot;: &quot;A String&quot;, # The product line of the Product.
},
},
],
&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.
}</pre>
</div>
<div class="method">
<code class="details" id="search_next">search_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>