Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListUserLicensesRequest.
Request message for UserLicenseService.ListUserLicenses .
Generated from protobuf message google.cloud.discoveryengine.v1.ListUserLicensesRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent UserStore
resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}
.
↳ page_size
int
Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
↳ page_token
string
Optional. A page token, received from a previous ListUserLicenses
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserLicenses
must match the call that provided the page token.
↳ filter
string
Optional. Filter for the list request. Supported fields: * * license_assignment_state
Examples: * * license_assignment_state = ASSIGNED
to list assigned user licenses. * * license_assignment_state = NO_LICENSE
to list not licensed users. * * license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN
to list users who attempted login but no license assigned. * * license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN
to filter out users who attempted login but no license assigned.
getParent
Required. The parent UserStore
resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}
.
string
setParent
Required. The parent UserStore
resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}
.
var
string
$this
getPageSize
Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50.
If this field is negative, an INVALID_ARGUMENT error is returned.
int
setPageSize
Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50.
If this field is negative, an INVALID_ARGUMENT error is returned.
var
int
$this
getPageToken
Optional. A page token, received from a previous ListUserLicenses
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserLicenses
must match the call that provided the page token.
string
setPageToken
Optional. A page token, received from a previous ListUserLicenses
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserLicenses
must match the call that provided the page token.
var
string
$this
getFilter
Optional. Filter for the list request.
Supported fields:
-
license_assignment_stateExamples: -
license_assignment_state = ASSIGNEDto list assigned user licenses. -
license_assignment_state = NO_LICENSEto list not licensed users. -
license_assignment_state = NO_LICENSE_ATTEMPTED_LOGINto list users who attempted login but no license assigned. -
license_assignment_state != NO_LICENSE_ATTEMPTED_LOGINto filter out users who attempted login but no license assigned.
string
setFilter
Optional. Filter for the list request.
Supported fields:
-
license_assignment_stateExamples: -
license_assignment_state = ASSIGNEDto list assigned user licenses. -
license_assignment_state = NO_LICENSEto list not licensed users. -
license_assignment_state = NO_LICENSE_ATTEMPTED_LOGINto list users who attempted login but no license assigned. -
license_assignment_state != NO_LICENSE_ATTEMPTED_LOGINto filter out users who attempted login but no license assigned.
var
string
$this
static::build
parent
string
Required. The parent UserStore
resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}
. Please see UserLicenseServiceClient::userStoreName()
for help formatting this field.
