Class ListUserGroupMembersRequest (0.48.0)

public final class ListUserGroupMembersRequest extends GeneratedMessage implements ListUserGroupMembersRequestOrBuilder

Request message for ListUserGroupMembers RPC.

Protobuf type google.marketingplatform.admin.v1alpha.ListUserGroupMembersRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListUserGroupMembersRequest getDefaultInstance()
Returns
Type Description
ListUserGroupMembersRequest

getDescriptor()

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

newBuilder()

public static ListUserGroupMembersRequest.Builder newBuilder()
Returns
Type Description
ListUserGroupMembersRequest.Builder

newBuilder(ListUserGroupMembersRequest prototype)

public static ListUserGroupMembersRequest.Builder newBuilder(ListUserGroupMembersRequest prototype)
Parameter
Name Description
prototype ListUserGroupMembersRequest
Returns
Type Description
ListUserGroupMembersRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListUserGroupMembersRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListUserGroupMembersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListUserGroupMembersRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListUserGroupMembersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListUserGroupMembersRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListUserGroupMembersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListUserGroupMembersRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListUserGroupMembersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListUserGroupMembersRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListUserGroupMembersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListUserGroupMembersRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListUserGroupMembersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserGroupMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListUserGroupMembersRequest> parser()
Returns
Type Description
Parser<ListUserGroupMembersRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListUserGroupMembersRequest getDefaultInstanceForType()
Returns
Type Description
ListUserGroupMembersRequest

getPageSize()

public int getPageSize()

Optional. The maximum number of user group members to return in one call. The service may return fewer than this value.

If unspecified, at most 50 user group members will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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 ListUserGroupMembers call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserGroupMembers 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 ListUserGroupMembers call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserGroupMembers 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 user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_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 user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListUserGroupMembersRequest> getParserForType()
Returns
Type Description
Parser<ListUserGroupMembersRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListUserGroupMembersRequest.Builder newBuilderForType()
Returns
Type Description
ListUserGroupMembersRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListUserGroupMembersRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListUserGroupMembersRequest.Builder
Overrides

toBuilder()

public ListUserGroupMembersRequest.Builder toBuilder()
Returns
Type Description
ListUserGroupMembersRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException