Discovery Engine v1beta API - Class ListUserLicensesRequest (1.0.0-beta24) 

public sealed class ListUserLicensesRequest : IMessage<ListUserLicensesRequest>, IEquatable<ListUserLicensesRequest>, IDeepCloneable<ListUserLicensesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Discovery Engine v1beta API class ListUserLicensesRequest.

Request message for [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1beta.UserLicenseService.ListUserLicenses].

Inheritance

object > ListUserLicensesRequest

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

ListUserLicensesRequest()

public ListUserLicensesRequest()

ListUserLicensesRequest(ListUserLicensesRequest)

public ListUserLicensesRequest(ListUserLicensesRequest other)
Parameter
Name Description
other ListUserLicensesRequest

Properties

Filter

public string Filter { get; set; }

Optional. Filter for the list request.

Supported fields:

  • license_assignment_state

  • user_principal * 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.
  • user_principal = user1@example.com to list user license for user1@example.com.
Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

Optional. The order in which the [UserLicense][google.cloud.discoveryengine.v1beta.UserLicense]s are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant.

Supported fields (only user_principal is supported for now):

  • user_principal

If not set, the default ordering is by user_principal.

Examples:

  • user_principal to order by user_principal in ascending order.
  • user_principal desc to order by user_principal in descending order.
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The parent [UserStore][google.cloud.discoveryengine.v1beta.UserStore] resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}.

Property Value
Type Description
string

ParentAsUserStoreName

public UserStoreName ParentAsUserStoreName { get; set; }

UserStoreName-typed view over the Parent resource name property.

Property Value
Type Description
UserStoreName