public final class SearchRequest extends GeneratedMessageV3 implements SearchRequestOrBuilder Request message for the ReportService.Search method.
Protobuf type google.shopping.merchant.reports.v1beta.SearchRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequestImplements
SearchRequestOrBuilderStatic Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SearchRequest getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static SearchRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder | |
newBuilder(SearchRequest prototype)
public static SearchRequest.Builder newBuilder(SearchRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | SearchRequest |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder | |
parseDelimitedFrom(InputStream input)
public static SearchRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static SearchRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static SearchRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static SearchRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static SearchRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static SearchRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<SearchRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<SearchRequest> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
public SearchRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchRequest | |
getPageSize()
public int getPageSize() Optional. Number of ReportRows to retrieve in a single page. Defaults to
the maximum of 1000. Values above 1000 are coerced to 1000.
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. |
getParserForType()
public Parser<SearchRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<SearchRequest> | |
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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public SearchRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public SearchRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |