Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::ListUserLicensesRequest (v2.3.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::ListUserLicensesRequest.

Request message for UserLicenseService.ListUserLicenses.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent [UserStore][] resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent [UserStore][] resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}.
Returns
  • (::String) — Required. The parent [UserStore][] resource name, format: projects/{project}/locations/{location}/userStores/{user_store_id}.