- 2.78.0 (latest)
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class ExportProductsRequest.Builder extends GeneratedMessageV3.Builder<ExportProductsRequest.Builder> implements ExportProductsRequestOrBuilderRequest message for ExportProducts method.
Protobuf type google.cloud.retail.v2beta.ExportProductsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportProductsRequest.BuilderImplements
ExportProductsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExportProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
build()
public ExportProductsRequest build()| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest |
|
buildPartial()
public ExportProductsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest |
|
clear()
public ExportProductsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ExportProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
clearFilter()
public ExportProductsRequest.Builder clearFilter() A filtering expression to specify restrictions on returned events.
The expression is a sequence of terms. Each term applies a restriction to
the returned products. Use this expression to restrict results to a
specific time range, tag, or stock state or to filter products by product
type.
For example, lastModifiedTime > "2012-04-23T18:25:43.511Z"
lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary
We expect only four types of fields:
* <code>lastModifiedTime</code>: This can be specified twice, once with a
less than operator and once with a greater than operator. The
<code>lastModifiedTime</code> restriction should result in one, contiguous,
valid, last-modified, time range.
* <code>productType</code>: Supported values are <code>primary</code> and <code>variant</code>. The
Boolean operators <code>OR</code> and <code>NOT</code> are supported if the expression is
enclosed in parentheses and must be separated from the
<code>productType</code> values by a space.
* <code>availability</code>: Supported values are <code>IN_STOCK</code>, <code>OUT_OF_STOCK</code>,
<code>PREORDER</code>, and <code>BACKORDER</code>. Boolean operators <code>OR</code> and <code>NOT</code> are
supported if the expression is enclosed in parentheses and must be
separated from the <code>availability</code> values by a space.
* <code>Tag expressions</code>: Restricts output to products that match all of the
specified tags. Boolean operators <code>OR</code> and <code>NOT</code> are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '<code>-"tagA"</code>', which
is equivalent to '<code>NOT "tagA"</code>'. Tag values must be double-quoted,
UTF-8 encoded strings and have a size limit of 1,000 characters.
Some examples of valid filters expressions:
- Example 1:
lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z" - Example 2:
lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant" - Example 3:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z" - Example 4:
lastModifiedTime > "2012-04-23T18:25:43.511Z" - Example 5:
availability = (IN_STOCK OR BACKORDER)
string filter = 3;
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
clearOutputConfig()
public ExportProductsRequest.Builder clearOutputConfig()Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
clearParent()
public ExportProductsRequest.Builder clearParent() Required. Resource name of a Branch,
and default_branch for branch_id component is supported. For example
projects/1234/locations/global/catalogs/default_catalog/branches/default_branch
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
This builder for chaining. |
clone()
public ExportProductsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
getDefaultInstanceForType()
public ExportProductsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter() A filtering expression to specify restrictions on returned events.
The expression is a sequence of terms. Each term applies a restriction to
the returned products. Use this expression to restrict results to a
specific time range, tag, or stock state or to filter products by product
type.
For example, lastModifiedTime > "2012-04-23T18:25:43.511Z"
lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary
We expect only four types of fields:
* <code>lastModifiedTime</code>: This can be specified twice, once with a
less than operator and once with a greater than operator. The
<code>lastModifiedTime</code> restriction should result in one, contiguous,
valid, last-modified, time range.
* <code>productType</code>: Supported values are <code>primary</code> and <code>variant</code>. The
Boolean operators <code>OR</code> and <code>NOT</code> are supported if the expression is
enclosed in parentheses and must be separated from the
<code>productType</code> values by a space.
* <code>availability</code>: Supported values are <code>IN_STOCK</code>, <code>OUT_OF_STOCK</code>,
<code>PREORDER</code>, and <code>BACKORDER</code>. Boolean operators <code>OR</code> and <code>NOT</code> are
supported if the expression is enclosed in parentheses and must be
separated from the <code>availability</code> values by a space.
* <code>Tag expressions</code>: Restricts output to products that match all of the
specified tags. Boolean operators <code>OR</code> and <code>NOT</code> are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '<code>-"tagA"</code>', which
is equivalent to '<code>NOT "tagA"</code>'. Tag values must be double-quoted,
UTF-8 encoded strings and have a size limit of 1,000 characters.
Some examples of valid filters expressions:
- Example 1:
lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z" - Example 2:
lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant" - Example 3:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z" - Example 4:
lastModifiedTime > "2012-04-23T18:25:43.511Z" - Example 5:
availability = (IN_STOCK OR BACKORDER)
string filter = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes() A filtering expression to specify restrictions on returned events.
The expression is a sequence of terms. Each term applies a restriction to
the returned products. Use this expression to restrict results to a
specific time range, tag, or stock state or to filter products by product
type.
For example, lastModifiedTime > "2012-04-23T18:25:43.511Z"
lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary
We expect only four types of fields:
* <code>lastModifiedTime</code>: This can be specified twice, once with a
less than operator and once with a greater than operator. The
<code>lastModifiedTime</code> restriction should result in one, contiguous,
valid, last-modified, time range.
* <code>productType</code>: Supported values are <code>primary</code> and <code>variant</code>. The
Boolean operators <code>OR</code> and <code>NOT</code> are supported if the expression is
enclosed in parentheses and must be separated from the
<code>productType</code> values by a space.
* <code>availability</code>: Supported values are <code>IN_STOCK</code>, <code>OUT_OF_STOCK</code>,
<code>PREORDER</code>, and <code>BACKORDER</code>. Boolean operators <code>OR</code> and <code>NOT</code> are
supported if the expression is enclosed in parentheses and must be
separated from the <code>availability</code> values by a space.
* <code>Tag expressions</code>: Restricts output to products that match all of the
specified tags. Boolean operators <code>OR</code> and <code>NOT</code> are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '<code>-"tagA"</code>', which
is equivalent to '<code>NOT "tagA"</code>'. Tag values must be double-quoted,
UTF-8 encoded strings and have a size limit of 1,000 characters.
Some examples of valid filters expressions:
- Example 1:
lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z" - Example 2:
lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant" - Example 3:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z" - Example 4:
lastModifiedTime > "2012-04-23T18:25:43.511Z" - Example 5:
availability = (IN_STOCK OR BACKORDER)
string filter = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getOutputConfig()
public OutputConfig getOutputConfig()Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OutputConfig |
The outputConfig. |
getOutputConfigBuilder()
public OutputConfig.Builder getOutputConfigBuilder()Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OutputConfig.Builder |
|
getOutputConfigOrBuilder()
public OutputConfigOrBuilder getOutputConfigOrBuilder()Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OutputConfigOrBuilder |
|
getParent()
public String getParent() Required. Resource name of a Branch,
and default_branch for branch_id component is supported. For example
projects/1234/locations/global/catalogs/default_catalog/branches/default_branch
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes() Required. Resource name of a Branch,
and default_branch for branch_id component is supported. For example
projects/1234/locations/global/catalogs/default_catalog/branches/default_branch
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
hasOutputConfig()
public boolean hasOutputConfig()Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the outputConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ExportProductsRequest other)
public ExportProductsRequest.Builder mergeFrom(ExportProductsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExportProductsRequest |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExportProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExportProductsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
mergeOutputConfig(OutputConfig value)
public ExportProductsRequest.Builder mergeOutputConfig(OutputConfig value)Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
OutputConfig |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExportProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ExportProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
setFilter(String value)
public ExportProductsRequest.Builder setFilter(String value) A filtering expression to specify restrictions on returned events.
The expression is a sequence of terms. Each term applies a restriction to
the returned products. Use this expression to restrict results to a
specific time range, tag, or stock state or to filter products by product
type.
For example, lastModifiedTime > "2012-04-23T18:25:43.511Z"
lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary
We expect only four types of fields:
* <code>lastModifiedTime</code>: This can be specified twice, once with a
less than operator and once with a greater than operator. The
<code>lastModifiedTime</code> restriction should result in one, contiguous,
valid, last-modified, time range.
* <code>productType</code>: Supported values are <code>primary</code> and <code>variant</code>. The
Boolean operators <code>OR</code> and <code>NOT</code> are supported if the expression is
enclosed in parentheses and must be separated from the
<code>productType</code> values by a space.
* <code>availability</code>: Supported values are <code>IN_STOCK</code>, <code>OUT_OF_STOCK</code>,
<code>PREORDER</code>, and <code>BACKORDER</code>. Boolean operators <code>OR</code> and <code>NOT</code> are
supported if the expression is enclosed in parentheses and must be
separated from the <code>availability</code> values by a space.
* <code>Tag expressions</code>: Restricts output to products that match all of the
specified tags. Boolean operators <code>OR</code> and <code>NOT</code> are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '<code>-"tagA"</code>', which
is equivalent to '<code>NOT "tagA"</code>'. Tag values must be double-quoted,
UTF-8 encoded strings and have a size limit of 1,000 characters.
Some examples of valid filters expressions:
- Example 1:
lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z" - Example 2:
lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant" - Example 3:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z" - Example 4:
lastModifiedTime > "2012-04-23T18:25:43.511Z" - Example 5:
availability = (IN_STOCK OR BACKORDER)
string filter = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ExportProductsRequest.Builder setFilterBytes(ByteString value) A filtering expression to specify restrictions on returned events.
The expression is a sequence of terms. Each term applies a restriction to
the returned products. Use this expression to restrict results to a
specific time range, tag, or stock state or to filter products by product
type.
For example, lastModifiedTime > "2012-04-23T18:25:43.511Z"
lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary
We expect only four types of fields:
* <code>lastModifiedTime</code>: This can be specified twice, once with a
less than operator and once with a greater than operator. The
<code>lastModifiedTime</code> restriction should result in one, contiguous,
valid, last-modified, time range.
* <code>productType</code>: Supported values are <code>primary</code> and <code>variant</code>. The
Boolean operators <code>OR</code> and <code>NOT</code> are supported if the expression is
enclosed in parentheses and must be separated from the
<code>productType</code> values by a space.
* <code>availability</code>: Supported values are <code>IN_STOCK</code>, <code>OUT_OF_STOCK</code>,
<code>PREORDER</code>, and <code>BACKORDER</code>. Boolean operators <code>OR</code> and <code>NOT</code> are
supported if the expression is enclosed in parentheses and must be
separated from the <code>availability</code> values by a space.
* <code>Tag expressions</code>: Restricts output to products that match all of the
specified tags. Boolean operators <code>OR</code> and <code>NOT</code> are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '<code>-"tagA"</code>', which
is equivalent to '<code>NOT "tagA"</code>'. Tag values must be double-quoted,
UTF-8 encoded strings and have a size limit of 1,000 characters.
Some examples of valid filters expressions:
- Example 1:
lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z" - Example 2:
lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant" - Example 3:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z" - Example 4:
lastModifiedTime > "2012-04-23T18:25:43.511Z" - Example 5:
availability = (IN_STOCK OR BACKORDER)
string filter = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
This builder for chaining. |
setOutputConfig(OutputConfig value)
public ExportProductsRequest.Builder setOutputConfig(OutputConfig value)Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
OutputConfig |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
setOutputConfig(OutputConfig.Builder builderForValue)
public ExportProductsRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
OutputConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
setParent(String value)
public ExportProductsRequest.Builder setParent(String value) Required. Resource name of a Branch,
and default_branch for branch_id component is supported. For example
projects/1234/locations/global/catalogs/default_catalog/branches/default_branch
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ExportProductsRequest.Builder setParentBytes(ByteString value) Required. Resource name of a Branch,
and default_branch for branch_id component is supported. For example
projects/1234/locations/global/catalogs/default_catalog/branches/default_branch
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 |
ExportProductsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExportProductsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportProductsRequest.Builder |
|