Class ListUserLicensesRequest.Builder (0.60.0)

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

Request message for UserLicenseService.ListUserLicenses.

Protobuf type google.cloud.discoveryengine.v1.ListUserLicensesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListUserLicensesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

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

clearField(Descriptors.FieldDescriptor field)

public ListUserLicensesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

clearFilter()

public ListUserLicensesRequest.Builder clearFilter()

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
Type Description
ListUserLicensesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListUserLicensesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

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.

clone()

public ListUserLicensesRequest.Builder clone()
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListUserLicensesRequest getDefaultInstanceForType()
Returns
Type Description
ListUserLicensesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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

The filter.

getFilterBytes()

public 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
Type Description
ByteString

The bytes for filter.

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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListUserLicensesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListUserLicensesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListUserLicensesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

setFilter(String value)

public ListUserLicensesRequest.Builder setFilter(String value)

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

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

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

Parameter
Name Description
value ByteString

The bytes for filter 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.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListUserLicensesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListUserLicensesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListUserLicensesRequest.Builder
Overrides