public static final class ListOrdersRequest.Builder extends GeneratedMessageV3.Builder<ListOrdersRequest.Builder> implements ListOrdersRequestOrBuilder
Request object for ListOrders
method.
Protobuf type google.ads.admanager.v1.ListOrdersRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListOrdersRequest.BuilderImplements
ListOrdersRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListOrdersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
build()
public ListOrdersRequest build()
Returns | |
---|---|
Type | Description |
ListOrdersRequest |
buildPartial()
public ListOrdersRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListOrdersRequest |
clear()
public ListOrdersRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListOrdersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
clearFilter()
public ListOrdersRequest.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 |
ListOrdersRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListOrdersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
clearOrderBy()
public ListOrdersRequest.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 |
ListOrdersRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListOrdersRequest.Builder clearPageSize()
Optional. The maximum number of Orders
to return. The service may return
fewer than this value. If unspecified, at most 50 Orders
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 |
ListOrdersRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListOrdersRequest.Builder clearPageToken()
Optional. A page token, received from a previous ListOrders
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListOrders
must match
the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
clearParent()
public ListOrdersRequest.Builder clearParent()
Required. The parent, which owns this collection of Orders.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
clearSkip()
public ListOrdersRequest.Builder clearSkip()
Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
clone()
public ListOrdersRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
getDefaultInstanceForType()
public ListOrdersRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListOrdersRequest |
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 Orders
to return. The service may return
fewer than this value. If unspecified, at most 50 Orders
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 ListOrders
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListOrders
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 ListOrders
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListOrders
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 Orders.
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 Orders.
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(ListOrdersRequest other)
public ListOrdersRequest.Builder mergeFrom(ListOrdersRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListOrdersRequest |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListOrdersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListOrdersRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListOrdersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListOrdersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
setFilter(String value)
public ListOrdersRequest.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 |
String The filter to set. |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListOrdersRequest.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 |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListOrdersRequest.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 |
String The orderBy to set. |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListOrdersRequest.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 |
ByteString The bytes for orderBy to set. |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListOrdersRequest.Builder setPageSize(int value)
Optional. The maximum number of Orders
to return. The service may return
fewer than this value. If unspecified, at most 50 Orders
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 |
ListOrdersRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListOrdersRequest.Builder setPageToken(String value)
Optional. A page token, received from a previous ListOrders
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListOrders
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 |
ListOrdersRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListOrdersRequest.Builder setPageTokenBytes(ByteString value)
Optional. A page token, received from a previous ListOrders
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListOrders
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 |
ListOrdersRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListOrdersRequest.Builder setParent(String value)
Required. The parent, which owns this collection of Orders.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListOrdersRequest.Builder setParentBytes(ByteString value)
Required. The parent, which owns this collection of Orders.
Format: networks/{network_code}
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 |
ListOrdersRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListOrdersRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
setSkip(int value)
public ListOrdersRequest.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 |
int The skip to set. |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListOrdersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListOrdersRequest.Builder |