public static final class ListYieldPartnersRequest.Builder extends GeneratedMessage.Builder<ListYieldPartnersRequest.Builder> implements ListYieldPartnersRequestOrBuilder Request message for ListYieldPartners.
Protobuf type google.ads.admanager.v1.ListYieldPartnersRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListYieldPartnersRequest.BuilderImplements
ListYieldPartnersRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ListYieldPartnersRequest build()| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest |
|
buildPartial()
public ListYieldPartnersRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest |
|
clear()
public ListYieldPartnersRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
|
clearFilter()
public ListYieldPartnersRequest.Builder clearFilter()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayName
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
clearOrderBy()
public ListYieldPartnersRequest.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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListYieldPartnersRequest.Builder clearPageSize() Optional. The maximum number of YieldPartners to return. The service may
return fewer than this value. If unspecified, at most 50 YieldPartners
will be returned. The maximum value is 1000; values greater than 1000 will
be coerced to 1000.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListYieldPartnersRequest.Builder clearPageToken() Optional. A page token, received from a previous ListYieldPartners call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldPartners must
match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
clearParent()
public ListYieldPartnersRequest.Builder clearParent() Required. The parent, which owns this collection of yield partners.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
clearSkip()
public ListYieldPartnersRequest.Builder clearSkip()Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public ListYieldPartnersRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest |
|
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
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayName
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
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayName
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 YieldPartners to return. The service may
return fewer than this value. If unspecified, at most 50 YieldPartners
will be returned. The maximum value is 1000; values greater than 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 ListYieldPartners call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldPartners 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 ListYieldPartners call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldPartners 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 yield partners.
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 yield partners.
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListYieldPartnersRequest other)
public ListYieldPartnersRequest.Builder mergeFrom(ListYieldPartnersRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListYieldPartnersRequest |
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListYieldPartnersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListYieldPartnersRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
|
setFilter(String value)
public ListYieldPartnersRequest.Builder setFilter(String value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayName
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListYieldPartnersRequest.Builder setFilterBytes(ByteString value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayName
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListYieldPartnersRequest.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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListYieldPartnersRequest.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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListYieldPartnersRequest.Builder setPageSize(int value) Optional. The maximum number of YieldPartners to return. The service may
return fewer than this value. If unspecified, at most 50 YieldPartners
will be returned. The maximum value is 1000; values greater than 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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListYieldPartnersRequest.Builder setPageToken(String value) Optional. A page token, received from a previous ListYieldPartners call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldPartners 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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListYieldPartnersRequest.Builder setPageTokenBytes(ByteString value) Optional. A page token, received from a previous ListYieldPartners call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldPartners 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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListYieldPartnersRequest.Builder setParent(String value) Required. The parent, which owns this collection of yield partners.
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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListYieldPartnersRequest.Builder setParentBytes(ByteString value) Required. The parent, which owns this collection of yield partners.
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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |
setSkip(int value)
public ListYieldPartnersRequest.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 |
ListYieldPartnersRequest.Builder |
This builder for chaining. |