public static final class SearchRequest.Builder extends GeneratedMessage.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder Request message for the ReportService.Search method.
Protobuf type google.shopping.merchant.reports.v1.SearchRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchRequest.BuilderImplements
SearchRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SearchRequest build()| Returns | |
|---|---|
| Type | Description |
SearchRequest |
|
buildPartial()
public SearchRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchRequest |
|
clear()
public SearchRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
clearPageSize()
public SearchRequest.Builder clearPageSize() Optional. Number of ReportRows to retrieve in a single page. Defaults to
- Values above 5000 are coerced to 5000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
clearPageToken()
public SearchRequest.Builder clearPageToken() Optional. Token of the page to retrieve. If not specified, the first page
of results is returned. In order to request the next page of results, the
value obtained from next_page_token in the previous response should be
used.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
clearParent()
public SearchRequest.Builder clearParent()Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
clearQuery()
public SearchRequest.Builder clearQuery()Required. Query that defines a report to be retrieved.
For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public SearchRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getPageSize()
public int getPageSize() Optional. Number of ReportRows to retrieve in a single page. Defaults to
- Values above 5000 are coerced to 5000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken() Optional. Token of the page to retrieve. If not specified, the first page
of results is returned. In order to request the next page of results, the
value obtained from next_page_token in the previous response should be
used.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() Optional. Token of the page to retrieve. If not specified, the first page
of results is returned. In order to request the next page of results, the
value obtained from next_page_token in the previous response should be
used.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent()Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getQuery()
public String getQuery()Required. Query that defines a report to be retrieved.
For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public ByteString getQueryBytes()Required. Query that defines a report to be retrieved.
For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeFrom(SearchRequest other)
public SearchRequest.Builder mergeFrom(SearchRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchRequest |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setPageSize(int value)
public SearchRequest.Builder setPageSize(int value) Optional. Number of ReportRows to retrieve in a single page. Defaults to
- Values above 5000 are coerced to 5000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public SearchRequest.Builder setPageToken(String value) Optional. Token of the page to retrieve. If not specified, the first page
of results is returned. In order to request the next page of results, the
value obtained from next_page_token in the previous response should be
used.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchRequest.Builder setPageTokenBytes(ByteString value) Optional. Token of the page to retrieve. If not specified, the first page
of results is returned. In order to request the next page of results, the
value obtained from next_page_token in the previous response should be
used.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setParent(String value)
public SearchRequest.Builder setParent(String value)Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public SearchRequest.Builder setParentBytes(ByteString value)Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setQuery(String value)
public SearchRequest.Builder setQuery(String value)Required. Query that defines a report to be retrieved.
For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setQueryBytes(ByteString value)
public SearchRequest.Builder setQueryBytes(ByteString value)Required. Query that defines a report to be retrieved.
For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |