public static final class ListUsersRequest.Builder extends GeneratedMessageV3.Builder<ListUsersRequest.Builder> implements ListUsersRequestOrBuilderRequest object for ListUsers method.
Protobuf type google.ads.admanager.v1.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 |
|
clearFilter()
public ListUsersRequest.Builder clearFilter()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListUsersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
clearOrderBy()
public ListUsersRequest.Builder clearOrderBy()Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
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 1000; values above 1000 will be coerced to 1000.
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: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
clearSkip()
public ListUsersRequest.Builder clearSkip()Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| 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 |
|
getFilter()
public String getFilter()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getOrderBy()
public String getOrderBy()Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
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 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 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: networks/{network_code}
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: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getSkip()
public int getSkip()Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The skip. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListUsersRequest other)
public ListUsersRequest.Builder mergeFrom(ListUsersRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListUsersRequest |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|
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 |
|
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 |
|
setFilter(String value)
public ListUsersRequest.Builder setFilter(String value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListUsersRequest.Builder setFilterBytes(ByteString value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListUsersRequest.Builder setOrderBy(String value)Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListUsersRequest.Builder setOrderByBytes(ByteString value)Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
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 1000; values above 1000 will be coerced to 1000.
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: networks/{network_code}
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: networks/{network_code}
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 |
|
setSkip(int value)
public ListUsersRequest.Builder setSkip(int value)Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe skip to set. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListUsersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest.Builder |
|