Discovery Engine API . projects . locations . userStores . userAvailability

Instance Methods

close()

Close httplib2 connections.

update(parent, body=None, x__xgafv=None)

Updates a UserAvailability.

Method Details

close()
Close httplib2 connections.
update(parent, body=None, x__xgafv=None)
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.
  "parent": "A String", # Optional. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
  "updateMask": "A String", # Optional. The list of fields to update. Only 'state' is supported; if unset, defaults to 'state'.
  "userAvailability": { # 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.
    "observeTime": "A String", # Optional. Deprecated: use `update_time` only.
    "state": "A String", # Optional. Whether the user can currently use the resource. Set by the caller on update. If unspecified, defaults to `ACTIVE`.
    "updateTime": "A String", # Output only. Timestamp when the most recent update to `state` was saved.
    "userPrincipal": "A String", # 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).
  "observeTime": "A String", # Optional. Deprecated: use `update_time` only.
  "state": "A String", # Optional. Whether the user can currently use the resource. Set by the caller on update. If unspecified, defaults to `ACTIVE`.
  "updateTime": "A String", # Output only. Timestamp when the most recent update to `state` was saved.
  "userPrincipal": "A String", # Required. Immutable. User principal (IdP subject for Workforce Identity, email for Google sign-in).
}