com.google.cloud.discoveryengine.v1

Class ListUserLicensesRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<ListUserLicensesRequest.Builder>

com.google.cloud.discoveryengine.v1.ListUserLicensesRequest.Builder

All Implemented Interfaces:

ListUserLicensesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListUserLicensesRequest

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

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

Protobuf type google.cloud.discoveryengine.v1.ListUserLicensesRequest

Method Summary

Modifier and Type	Method and Description
ListUserLicensesRequest	build()
ListUserLicensesRequest	buildPartial()
ListUserLicensesRequest.Builder	clear()
ListUserLicensesRequest.Builder	clearFilter() Optional.
ListUserLicensesRequest.Builder	clearPageSize() Optional.
ListUserLicensesRequest.Builder	clearPageToken() Optional.
ListUserLicensesRequest.Builder	clearParent() Required.
ListUserLicensesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListUserLicensesRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListUserLicensesRequest.Builder	mergeFrom(ListUserLicensesRequest other)
ListUserLicensesRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListUserLicensesRequest.Builder	setFilter(String value) Optional.
ListUserLicensesRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) Optional.
ListUserLicensesRequest.Builder	setPageSize(int value) Optional.
ListUserLicensesRequest.Builder	setPageToken(String value) Optional.
ListUserLicensesRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) Optional.
ListUserLicensesRequest.Builder	setParent(String value) Required.
ListUserLicensesRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListUserLicensesRequest.Builder>

clear

public ListUserLicensesRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ListUserLicensesRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListUserLicensesRequest.Builder>

getDefaultInstanceForType

public ListUserLicensesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListUserLicensesRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListUserLicensesRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public ListUserLicensesRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListUserLicensesRequest.Builder>

mergeFrom

public ListUserLicensesRequest.Builder mergeFrom(ListUserLicensesRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListUserLicensesRequest.Builder>

mergeFrom

public ListUserLicensesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListUserLicensesRequest.Builder>

Throws:

IOException

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

Specified by:

getParent in interface ListUserLicensesRequestOrBuilder

Returns:

The parent.

getParentBytes

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

Specified by:

getParentBytes in interface ListUserLicensesRequestOrBuilder

Returns:

The bytes for parent.

setParent

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

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

public ListUserLicensesRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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

Specified by:

getPageSize in interface ListUserLicensesRequestOrBuilder

Returns:

The pageSize.

setPageSize

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

Parameters:

value - The pageSize to set.

Returns:

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:

This builder for chaining.

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

Specified by:

getPageToken in interface ListUserLicensesRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

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

Specified by:

getPageTokenBytes in interface ListUserLicensesRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

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

Parameters:

value - The pageToken to set.

Returns:

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:

This builder for chaining.

setPageTokenBytes

public ListUserLicensesRequest.Builder setPageTokenBytes(com.google.protobuf.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];

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

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

Specified by:

getFilter in interface ListUserLicensesRequestOrBuilder

Returns:

The filter.

getFilterBytes

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

Specified by:

getFilterBytes in interface ListUserLicensesRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setFilterBytes

public ListUserLicensesRequest.Builder setFilterBytes(com.google.protobuf.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];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.