Discovery Engine API . projects . locations . userStores . userAvailabilities

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

Updates multiple UserAvailabilitys.

Args:
  parent: string, Required. 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.BatchUpdateUserAvailabilities method.
  "requests": [ # Required. The UserAvailabilitys to update. Maximum of 1000 at a time: if more are passed in, returns INVALID_ARGUMENT. Batch is all or nothing; either all updates succeed or none. The `parent` field in each child request must either be empty, or match the `parent` field in the batch request. If there is a mismatch, that will also result in an INVALID_ARGUMENT being returned.
    { # 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:

    { # Response message for UserStoreService.BatchUpdateUserAvailabilities method.
  "userAvailabilities": [ # The updated UserAvailabilitys.
    { # 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).
    },
  ],
}

close()

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the UserAvailabilitys.

Args:
  parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required)
  filter: string, Optional. Filter for the list request. Supported fields (only `user_principal` is supported for now): * `user_principal` (will be normalized for matching) Examples: * `user_principal = "user1@example.com"` to list user availability for `user1@example.com`.
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
  pageToken: string, Optional. A page token, received from a previous `ListUserAvailabilities` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserAvailabilities` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for UserStoreService.ListUserAvailabilities method.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "userAvailabilities": [ # The UserAvailabilitys matching the request.
    { # 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).
    },
  ],
}

list_next(previous_request, previous_response)

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 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.