public static final class ListUsersRequest.Builder extends GeneratedMessageV3.Builder<ListUsersRequest.Builder> implements ListUsersRequestOrBuilder Request message for the ListUsers method.
Protobuf type google.shopping.merchant.accounts.v1beta.ListUsersRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListUsersRequest.BuilderImplements
ListUsersRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListUsersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
build()
public ListUsersRequest build()| Returns | |
|---|---|
| Type | Description |
ListUsersRequest |
|
buildPartial()
public ListUsersRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListUsersRequest |
|
clear()
public ListUsersRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListUsersRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ListUsersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
clearPageSize()
public ListUsersRequest.Builder clearPageSize()Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListUsersRequest.Builder clearPageToken() Optional. A page token, received from a previous ListUsers call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUsers must match
the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
clearParent()
public ListUsersRequest.Builder clearParent() Required. The parent, which owns this collection of users.
Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
clone()
public ListUsersRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
getDefaultInstanceForType()
public ListUsersRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListUsersRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getPageSize()
public int getPageSize()Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
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 ListUsers call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUsers 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 ListUsers call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUsers 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, which owns this collection of users.
Format: accounts/{account}
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, which owns this collection of users.
Format: accounts/{account}
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListUsersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListUsersRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
mergeFrom(ListUsersRequest other)
public ListUsersRequest.Builder mergeFrom(ListUsersRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListUsersRequest |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListUsersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListUsersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
setPageSize(int value)
public ListUsersRequest.Builder setPageSize(int value)Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListUsersRequest.Builder setPageToken(String value) Optional. A page token, received from a previous ListUsers call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUsers must match
the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListUsersRequest.Builder setPageTokenBytes(ByteString value) Optional. A page token, received from a previous ListUsers call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUsers must match
the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListUsersRequest.Builder setParent(String value) Required. The parent, which owns this collection of users.
Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListUsersRequest.Builder setParentBytes(ByteString value) Required. The parent, which owns this collection of users.
Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListUsersRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListUsersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|