blob: d5f3f1aac203b951ab988f47e6d69aa13816cd2d [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="prod_tt_sasportal_v1alpha1.html">SAS Portal API (Testing)</a> . <a href="prod_tt_sasportal_v1alpha1.customers.html">customers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="prod_tt_sasportal_v1alpha1.customers.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>
<p class="toc_element">
<code><a href="prod_tt_sasportal_v1alpha1.customers.devices.html">devices()</a></code>
</p>
<p class="firstline">Returns the devices Resource.</p>
<p class="toc_element">
<code><a href="prod_tt_sasportal_v1alpha1.customers.nodes.html">nodes()</a></code>
</p>
<p class="firstline">Returns the nodes Resource.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a requested customer.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of requested customers.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing customer.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns a requested customer.
Args:
name: string, Required. The name of the customer. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a SAS customer.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
&quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
&quot;A String&quot;,
],
&quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns a list of requested customers.
Args:
pageToken: string, A pagination token returned from a previous call to ListCustomers method that indicates where
this listing should continue from.
pageSize: integer, The maximum number of customers
to return in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for `ListCustomers`.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A pagination token returned from a previous call to ListCustomers method that indicates from
# where listing should continue. If the field is missing or empty, it means
# there are no more customers.
&quot;customers&quot;: [ # The list of customers that
# match the request.
{ # Entity representing a SAS customer.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
&quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
&quot;A String&quot;,
],
&quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing customer.
Args:
name: string, Output only. Resource name of the customer. (required)
body: object, The request body.
The object takes the form of:
{ # Entity representing a SAS customer.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
&quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
&quot;A String&quot;,
],
&quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
}
updateMask: string, Fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a SAS customer.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
&quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
&quot;A String&quot;,
],
&quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
}</pre>
</div>
</body></html>