Class SearchRequest.Builder (0.12.0)

public static final class SearchRequest.Builder extends GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder

Request message for the ReportService.Search method.

Protobuf type google.shopping.merchant.reports.v1beta.SearchRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

build()

public SearchRequest build()
Returns
TypeDescription
SearchRequest

buildPartial()

public SearchRequest buildPartial()
Returns
TypeDescription
SearchRequest

clear()

public SearchRequest.Builder clear()
Returns
TypeDescription
SearchRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchRequest.Builder
Overrides

clearPageSize()

public SearchRequest.Builder clearPageSize()

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
SearchRequest.Builder

This builder for chaining.

clone()

public SearchRequest.Builder clone()
Returns
TypeDescription
SearchRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for query.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchRequest.Builder
Overrides

mergeFrom(SearchRequest other)

public SearchRequest.Builder mergeFrom(SearchRequest other)
Parameter
NameDescription
otherSearchRequest
Returns
TypeDescription
SearchRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

setPageSize(int value)

public SearchRequest.Builder setPageSize(int value)

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];

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
valueString

The query to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.Builder
Overrides