docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userAvailability.html

<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="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.userStores.html">userStores</a> . <a href="discoveryengine_v1alpha.projects.locations.userStores.userAvailability.html">userAvailability</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="#update">update(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a UserAvailability.</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="update">update(parent, body=None, x__xgafv=None)</code>
  <pre>Updates a UserAvailability.

Args:
  parent: string, Optional. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for UserStoreService.UpdateUserAvailability method. Also nested within BatchUpdateUserAvailabilityRequest for the UserStoreService.BatchUpdateUserAvailability method. `parent` is a required field when this message is used for a single Update, but is optional when used for a BatchUpdate.
  &quot;parent&quot;: &quot;A String&quot;, # Optional. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
  &quot;updateMask&quot;: &quot;A String&quot;, # Optional. The list of fields to update. Only &#x27;state&#x27; is supported; if unset, defaults to &#x27;state&#x27;.
  &quot;userAvailability&quot;: { # Tracks whether a resource is available for a given user (distinct from whether the user is allowed to use that resource by licensing, etc). # Required. The UserAvailability to update.
    &quot;observeTime&quot;: &quot;A String&quot;, # Optional. Deprecated: use `update_time` only.
    &quot;state&quot;: &quot;A String&quot;, # Optional. Whether the user can currently use the resource. Set by the caller on update. If unspecified, defaults to `ACTIVE`.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the most recent update to `state` was saved.
    &quot;userPrincipal&quot;: &quot;A String&quot;, # Required. Immutable. User principal (IdP subject for Workforce Identity, email for Google sign-in).
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Tracks whether a resource is available for a given user (distinct from whether the user is allowed to use that resource by licensing, etc).
  &quot;observeTime&quot;: &quot;A String&quot;, # Optional. Deprecated: use `update_time` only.
  &quot;state&quot;: &quot;A String&quot;, # Optional. Whether the user can currently use the resource. Set by the caller on update. If unspecified, defaults to `ACTIVE`.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the most recent update to `state` was saved.
  &quot;userPrincipal&quot;: &quot;A String&quot;, # Required. Immutable. User principal (IdP subject for Workforce Identity, email for Google sign-in).
}</pre>
</div>

</body></html>