Class ListUserGroupMembersRequest.Builder (0.48.0)

public static final class ListUserGroupMembersRequest.Builder extends GeneratedMessage.Builder<ListUserGroupMembersRequest.Builder> implements ListUserGroupMembersRequestOrBuilder

Request message for ListUserGroupMembers RPC.

Protobuf type google.marketingplatform.admin.v1alpha.ListUserGroupMembersRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListUserGroupMembersRequest build()
Returns
Type Description
ListUserGroupMembersRequest

buildPartial()

public ListUserGroupMembersRequest buildPartial()
Returns
Type Description
ListUserGroupMembersRequest

clear()

public ListUserGroupMembersRequest.Builder clear()
Returns
Type Description
ListUserGroupMembersRequest.Builder
Overrides

clearPageSize()

public ListUserGroupMembersRequest.Builder clearPageSize()

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
ListUserGroupMembersRequest.Builder

This builder for chaining.

clearPageToken()

public ListUserGroupMembersRequest.Builder clearPageToken()

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
ListUserGroupMembersRequest.Builder

This builder for chaining.

clearParent()

public ListUserGroupMembersRequest.Builder clearParent()

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
ListUserGroupMembersRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListUserGroupMembersRequest getDefaultInstanceForType()
Returns
Type Description
ListUserGroupMembersRequest

getDescriptorForType()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListUserGroupMembersRequest other)

public ListUserGroupMembersRequest.Builder mergeFrom(ListUserGroupMembersRequest other)
Parameter
Name Description
other ListUserGroupMembersRequest
Returns
Type Description
ListUserGroupMembersRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListUserGroupMembersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserGroupMembersRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

setPageSize(int value)

public ListUserGroupMembersRequest.Builder setPageSize(int value)

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListUserGroupMembersRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListUserGroupMembersRequest.Builder setPageToken(String value)

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListUserGroupMembersRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListUserGroupMembersRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListUserGroupMembersRequest.Builder

This builder for chaining.

setParent(String value)

public ListUserGroupMembersRequest.Builder setParent(String value)

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListUserGroupMembersRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListUserGroupMembersRequest.Builder setParentBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListUserGroupMembersRequest.Builder

This builder for chaining.