public static final class SearchPartnerLinksRequest.Builder extends GeneratedMessage.Builder<SearchPartnerLinksRequest.Builder> implements SearchPartnerLinksRequestOrBuilderRequest to search for PartnerLink resources. Returns a SearchPartnerLinksResponse.
Protobuf type google.ads.datamanager.v1.SearchPartnerLinksRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchPartnerLinksRequest.BuilderImplements
SearchPartnerLinksRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SearchPartnerLinksRequest build()| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest |
|
buildPartial()
public SearchPartnerLinksRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest |
|
clear()
public SearchPartnerLinksRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
|
clearFilter()
public SearchPartnerLinksRequest.Builder clearFilter() Optional. A filter string. All fields need to
be on the left hand side of each condition (for example: partner_link_id =
123456789). Fields must be specified using either all camel
case or all snake
case. Don't use a combination of
camel case and snake case.
Supported operations:
AND=!=Supported fields:
partner_link_idowning_account.account_typeowning_account.account_idpartner_account.account_typepartner_account.account_idExample:
owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
clearPageSize()
public SearchPartnerLinksRequest.Builder clearPageSize()The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
clearPageToken()
public SearchPartnerLinksRequest.Builder clearPageToken() A page token, received from a previous SearchPartnerLinks call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to SearchPartnerLinks
must match the call that provided the page token.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
clearParent()
public SearchPartnerLinksRequest.Builder clearParent() Required. Account to search for partner links. If no filter is specified,
all partner links where this account is either the owning_account or
partner_account are returned.
Format: accountTypes/{account_type}/accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public SearchPartnerLinksRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter() Optional. A filter string. All fields need to
be on the left hand side of each condition (for example: partner_link_id =
123456789). Fields must be specified using either all camel
case or all snake
case. Don't use a combination of
camel case and snake case.
Supported operations:
AND=!=Supported fields:
partner_link_idowning_account.account_typeowning_account.account_idpartner_account.account_typepartner_account.account_idExample:
owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes() Optional. A filter string. All fields need to
be on the left hand side of each condition (for example: partner_link_id =
123456789). Fields must be specified using either all camel
case or all snake
case. Don't use a combination of
camel case and snake case.
Supported operations:
AND=!=Supported fields:
partner_link_idowning_account.account_typeowning_account.account_idpartner_account.account_typepartner_account.account_idExample:
owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public int getPageSize()The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken() A page token, received from a previous SearchPartnerLinks call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to SearchPartnerLinks
must match the call that provided the page token.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() A page token, received from a previous SearchPartnerLinks call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to SearchPartnerLinks
must match the call that provided the page token.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent() Required. Account to search for partner links. If no filter is specified,
all partner links where this account is either the owning_account or
partner_account are returned.
Format: accountTypes/{account_type}/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. Account to search for partner links. If no filter is specified,
all partner links where this account is either the owning_account or
partner_account are returned.
Format: accountTypes/{account_type}/accounts/{account}
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchPartnerLinksRequest other)
public SearchPartnerLinksRequest.Builder mergeFrom(SearchPartnerLinksRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchPartnerLinksRequest |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchPartnerLinksRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchPartnerLinksRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
|
setFilter(String value)
public SearchPartnerLinksRequest.Builder setFilter(String value) Optional. A filter string. All fields need to
be on the left hand side of each condition (for example: partner_link_id =
123456789). Fields must be specified using either all camel
case or all snake
case. Don't use a combination of
camel case and snake case.
Supported operations:
AND=!=Supported fields:
partner_link_idowning_account.account_typeowning_account.account_idpartner_account.account_typepartner_account.account_idExample:
owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public SearchPartnerLinksRequest.Builder setFilterBytes(ByteString value) Optional. A filter string. All fields need to
be on the left hand side of each condition (for example: partner_link_id =
123456789). Fields must be specified using either all camel
case or all snake
case. Don't use a combination of
camel case and snake case.
Supported operations:
AND=!=Supported fields:
partner_link_idowning_account.account_typeowning_account.account_idpartner_account.account_typepartner_account.account_idExample:
owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public SearchPartnerLinksRequest.Builder setPageSize(int value)The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
int32 page_size = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public SearchPartnerLinksRequest.Builder setPageToken(String value) A page token, received from a previous SearchPartnerLinks call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to SearchPartnerLinks
must match the call that provided the page token.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchPartnerLinksRequest.Builder setPageTokenBytes(ByteString value) A page token, received from a previous SearchPartnerLinks call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to SearchPartnerLinks
must match the call that provided the page token.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
setParent(String value)
public SearchPartnerLinksRequest.Builder setParent(String value) Required. Account to search for partner links. If no filter is specified,
all partner links where this account is either the owning_account or
partner_account are returned.
Format: accountTypes/{account_type}/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 |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public SearchPartnerLinksRequest.Builder setParentBytes(ByteString value) Required. Account to search for partner links. If no filter is specified,
all partner links where this account is either the owning_account or
partner_account are returned.
Format: accountTypes/{account_type}/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 |
SearchPartnerLinksRequest.Builder |
This builder for chaining. |