Class ListUserLicensesRequest.Builder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class ListUserLicensesRequest.Builder extends GeneratedMessage.Builder<ListUserLicensesRequest.Builder> implements ListUserLicensesRequestOrBuilder

Request message for UserLicenseService.ListUserLicenses.

Protobuf type google.cloud.discoveryengine.v1beta.ListUserLicensesRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListUserLicensesRequest.Builder

Implements

ListUserLicensesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public ListUserLicensesRequest build()

Returns
Type	Description
ListUserLicensesRequest

buildPartial()

public ListUserLicensesRequest buildPartial()

Returns
Type	Description
ListUserLicensesRequest

clear()

public ListUserLicensesRequest.Builder clear()

Returns
Type	Description
ListUserLicensesRequest.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearFilter()

public ListUserLicensesRequest.Builder clearFilter()

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 = [e-mail] to list user license for [e-mail].

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

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

clearOrderBy()

public ListUserLicensesRequest.Builder clearOrderBy()

Optional. The order in which the UserLicenses 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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

clearPageSize()

public ListUserLicensesRequest.Builder clearPageSize()

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
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

clearPageToken()

public ListUserLicensesRequest.Builder clearPageToken()

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
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

clearParent()

public ListUserLicensesRequest.Builder clearParent()

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
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

getDefaultInstanceForType()

public ListUserLicensesRequest getDefaultInstanceForType()

Returns
Type	Description
ListUserLicensesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

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 = [e-mail] to list user license for [e-mail].

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

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

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 = [e-mail] to list user license for [e-mail].

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

Returns
Type	Description
ByteString	The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. The order in which the UserLicenses 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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. The order in which the UserLicenses 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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public 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
Type	Description
int	The pageSize.

getPageToken()

public 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
Type	Description
String	The pageToken.

getPageTokenBytes()

public 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
Type	Description
ByteString	The bytes for pageToken.

getParent()

public 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
Type	Description
String	The parent.

getParentBytes()

public 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
Type	Description
ByteString	The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(ListUserLicensesRequest other)

public ListUserLicensesRequest.Builder mergeFrom(ListUserLicensesRequest other)

Parameter
Name	Description
other	ListUserLicensesRequest

Returns
Type	Description
ListUserLicensesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListUserLicensesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListUserLicensesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListUserLicensesRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListUserLicensesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setFilter(String value)

public ListUserLicensesRequest.Builder setFilter(String value)

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 = [e-mail] to list user license for [e-mail].

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

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListUserLicensesRequest.Builder setFilterBytes(ByteString value)

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 = [e-mail] to list user license for [e-mail].

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

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setOrderBy(String value)

public ListUserLicensesRequest.Builder setOrderBy(String value)

Optional. The order in which the UserLicenses 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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The orderBy to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListUserLicensesRequest.Builder setOrderByBytes(ByteString value)

Optional. The order in which the UserLicenses 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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for orderBy to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListUserLicensesRequest.Builder setPageSize(int value)

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];

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListUserLicensesRequest.Builder setPageToken(String value)

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];

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListUserLicensesRequest.Builder setPageTokenBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for pageToken to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setParent(String value)

public ListUserLicensesRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ListUserLicensesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for parent to set.

Returns
Type	Description
ListUserLicensesRequest.Builder	This builder for chaining.