com.google.cloud.discoveryengine.v1

Class ListUserLicensesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.ListUserLicensesRequest

All Implemented Interfaces:

ListUserLicensesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class ListUserLicensesRequest
extends com.google.protobuf.GeneratedMessage
implements ListUserLicensesRequestOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1.ListUserLicensesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListUserLicensesRequest.Builder Request message for [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ListUserLicensesRequest	getDefaultInstance()
ListUserLicensesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<ListUserLicensesRequest>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListUserLicensesRequest.Builder	newBuilder()
static ListUserLicensesRequest.Builder	newBuilder(ListUserLicensesRequest prototype)
ListUserLicensesRequest.Builder	newBuilderForType()
protected ListUserLicensesRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ListUserLicensesRequest	parseDelimitedFrom(InputStream input)
static ListUserLicensesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListUserLicensesRequest	parseFrom(byte[] data)
static ListUserLicensesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListUserLicensesRequest	parseFrom(ByteBuffer data)
static ListUserLicensesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListUserLicensesRequest	parseFrom(com.google.protobuf.ByteString data)
static ListUserLicensesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListUserLicensesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListUserLicensesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListUserLicensesRequest	parseFrom(InputStream input)
static ListUserLicensesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListUserLicensesRequest>	parser()
ListUserLicensesRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

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

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ListUserLicensesRequest parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListUserLicensesRequest parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListUserLicensesRequest parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListUserLicensesRequest parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListUserLicensesRequest parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListUserLicensesRequest parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListUserLicensesRequest parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static ListUserLicensesRequest parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListUserLicensesRequest parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListUserLicensesRequest parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static ListUserLicensesRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static ListUserLicensesRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public ListUserLicensesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListUserLicensesRequest.Builder newBuilder()

newBuilder

public static ListUserLicensesRequest.Builder newBuilder(ListUserLicensesRequest prototype)

toBuilder

public ListUserLicensesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListUserLicensesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static ListUserLicensesRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ListUserLicensesRequest> parser()

getParserForType

public com.google.protobuf.Parser<ListUserLicensesRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public ListUserLicensesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder