Generated from protobuf messagegoogle.cloud.discoveryengine.v1.ListUserLicensesRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parentUserStoreresource 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 previousListUserLicensescall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListUserLicensesmust match the call that provided the page token.
↳ filter
string
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.
getParent
Required. The parentUserStoreresource name, format:projects/{project}/locations/{location}/userStores/{user_store_id}.
Returns
Type
Description
string
setParent
Required. The parentUserStoreresource name, format:projects/{project}/locations/{location}/userStores/{user_store_id}.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token, received from a previousListUserLicensescall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListUserLicensesmust match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previousListUserLicensescall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListUserLicensesmust match the call that provided the page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parentUserStoreresource name, format:projects/{project}/locations/{location}/userStores/{user_store_id}. Please seeUserLicenseServiceClient::userStoreName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class ListUserLicensesRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.ListUserLicensesRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.ListUserLicensesRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.ListUserLicensesRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.ListUserLicensesRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.ListUserLicensesRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.ListUserLicensesRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.ListUserLicensesRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.ListUserLicensesRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.ListUserLicensesRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.ListUserLicensesRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.ListUserLicensesRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.ListUserLicensesRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.ListUserLicensesRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.ListUserLicensesRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.ListUserLicensesRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.ListUserLicensesRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.ListUserLicensesRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListUserLicensesRequest.\n\nRequest message for\n[UserLicenseService.ListUserLicenses](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.UserLicenseServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_UserLicenseServiceClient__listUserLicenses__).\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.ListUserLicensesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent UserStore resource name, format:\n`projects/{project}/locations/{location}/userStores/{user_store_id}`.\n\n### setParent\n\nRequired. The parent UserStore resource name, format:\n`projects/{project}/locations/{location}/userStores/{user_store_id}`.\n\n### getPageSize\n\nOptional. Requested page size. Server may return fewer items than\nrequested. If unspecified, defaults to 10. The maximum value is 50; values\nabove 50 will be coerced to 50.\n\nIf this field is negative, an INVALID_ARGUMENT error is returned.\n\n### setPageSize\n\nOptional. Requested page size. Server may return fewer items than\nrequested. If unspecified, defaults to 10. The maximum value is 50; values\nabove 50 will be coerced to 50.\n\nIf this field is negative, an INVALID_ARGUMENT error is returned.\n\n### getPageToken\n\nOptional. A page token, received from a previous `ListUserLicenses` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListUserLicenses`\nmust match the call that provided the page token.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListUserLicenses` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListUserLicenses`\nmust match the call that provided the page token.\n\n### getFilter\n\nOptional. Filter for the list request.\n\nSupported fields:\n\n- `license_assignment_state` Examples:\n- `license_assignment_state = ASSIGNED` to list assigned user licenses.\n- `license_assignment_state = NO_LICENSE` to list not licensed users.\n- `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned.\n- `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.\n\n### setFilter\n\nOptional. Filter for the list request.\n\nSupported fields:\n\n- `license_assignment_state` Examples:\n- `license_assignment_state = ASSIGNED` to list assigned user licenses.\n- `license_assignment_state = NO_LICENSE` to list not licensed users.\n- `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned.\n- `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.\n\n### static::build"]]
