com.google.cloud.discoveryengine.v1

Interface ListUserLicensesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListUserLicensesRequest, ListUserLicensesRequest.Builder

@Generated
public interface ListUserLicensesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

int 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.
 

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageSize.

getPageToken

String 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 page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 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 page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for pageToken.

getFilter

String getFilter()

 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.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.