public static final class ExportProductsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder> implements ExportProductsRequestOrBuilder
Request message for ExportProducts method.Protobuf type
google.cloud.retail.v2alpha.ExportProductsRequest| Modifier and Type | Method and Description |
|---|---|
ExportProductsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ExportProductsRequest |
build() |
ExportProductsRequest |
buildPartial() |
ExportProductsRequest.Builder |
clear() |
ExportProductsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ExportProductsRequest.Builder |
clearFilter()
A filtering expression to specify restrictions on returned events.
|
ExportProductsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ExportProductsRequest.Builder |
clearOutputConfig()
Required.
|
ExportProductsRequest.Builder |
clearParent()
Required.
|
ExportProductsRequest.Builder |
clone() |
ExportProductsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getFilter()
A filtering expression to specify restrictions on returned events.
|
com.google.protobuf.ByteString |
getFilterBytes()
A filtering expression to specify restrictions on returned events.
|
OutputConfig |
getOutputConfig()
Required.
|
OutputConfig.Builder |
getOutputConfigBuilder()
Required.
|
OutputConfigOrBuilder |
getOutputConfigOrBuilder()
Required.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
boolean |
hasOutputConfig()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ExportProductsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ExportProductsRequest.Builder |
mergeFrom(ExportProductsRequest other) |
ExportProductsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ExportProductsRequest.Builder |
mergeOutputConfig(OutputConfig value)
Required.
|
ExportProductsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ExportProductsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ExportProductsRequest.Builder |
setFilter(String value)
A filtering expression to specify restrictions on returned events.
|
ExportProductsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
A filtering expression to specify restrictions on returned events.
|
ExportProductsRequest.Builder |
setOutputConfig(OutputConfig.Builder builderForValue)
Required.
|
ExportProductsRequest.Builder |
setOutputConfig(OutputConfig value)
Required.
|
ExportProductsRequest.Builder |
setParent(String value)
Required.
|
ExportProductsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
ExportProductsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ExportProductsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ExportProductsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ExportProductsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ExportProductsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder mergeFrom(ExportProductsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public ExportProductsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportProductsRequest.Builder>IOExceptionpublic String getParent()
Required. Resource name of a [Branch][google.cloud.retail.v2alpha.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) = { ... }
getParent in interface ExportProductsRequestOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
Required. Resource name of a [Branch][google.cloud.retail.v2alpha.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) = { ... }
getParentBytes in interface ExportProductsRequestOrBuilderpublic ExportProductsRequest.Builder setParent(String value)
Required. Resource name of a [Branch][google.cloud.retail.v2alpha.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) = { ... }
value - The parent to set.public ExportProductsRequest.Builder clearParent()
Required. Resource name of a [Branch][google.cloud.retail.v2alpha.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) = { ... }
public ExportProductsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
Required. Resource name of a [Branch][google.cloud.retail.v2alpha.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) = { ... }
value - The bytes for parent to set.public boolean hasOutputConfig()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
hasOutputConfig in interface ExportProductsRequestOrBuilderpublic OutputConfig getOutputConfig()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputConfig in interface ExportProductsRequestOrBuilderpublic ExportProductsRequest.Builder setOutputConfig(OutputConfig value)
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
public ExportProductsRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
public ExportProductsRequest.Builder mergeOutputConfig(OutputConfig value)
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
public ExportProductsRequest.Builder clearOutputConfig()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
public OutputConfig.Builder getOutputConfigBuilder()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
public OutputConfigOrBuilder getOutputConfigOrBuilder()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputConfigOrBuilder in interface ExportProductsRequestOrBuilderpublic 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:
* `lastModifiedTime`: This can be specified twice, once with a
less than operator and once with a greater than operator. The
`lastModifiedTime` restriction should result in one, contiguous,
valid, last-modified, time range.
* `productType`: Supported values are `primary` and `variant`. The
Boolean operators `OR` and `NOT` are supported if the expression is
enclosed in parentheses and must be separated from the
`productType` values by a space.
* `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`,
`PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are
supported if the expression is enclosed in parentheses and must be
separated from the `availability` values by a space.
* `Tag expressions`: Restricts output to products that match all of the
specified tags. Boolean operators `OR` and `NOT` are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '`-"tagA"`', which
is equivalent to '`NOT "tagA"`'. 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;getFilter in interface ExportProductsRequestOrBuilderpublic com.google.protobuf.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:
* `lastModifiedTime`: This can be specified twice, once with a
less than operator and once with a greater than operator. The
`lastModifiedTime` restriction should result in one, contiguous,
valid, last-modified, time range.
* `productType`: Supported values are `primary` and `variant`. The
Boolean operators `OR` and `NOT` are supported if the expression is
enclosed in parentheses and must be separated from the
`productType` values by a space.
* `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`,
`PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are
supported if the expression is enclosed in parentheses and must be
separated from the `availability` values by a space.
* `Tag expressions`: Restricts output to products that match all of the
specified tags. Boolean operators `OR` and `NOT` are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '`-"tagA"`', which
is equivalent to '`NOT "tagA"`'. 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;getFilterBytes in interface ExportProductsRequestOrBuilderpublic 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:
* `lastModifiedTime`: This can be specified twice, once with a
less than operator and once with a greater than operator. The
`lastModifiedTime` restriction should result in one, contiguous,
valid, last-modified, time range.
* `productType`: Supported values are `primary` and `variant`. The
Boolean operators `OR` and `NOT` are supported if the expression is
enclosed in parentheses and must be separated from the
`productType` values by a space.
* `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`,
`PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are
supported if the expression is enclosed in parentheses and must be
separated from the `availability` values by a space.
* `Tag expressions`: Restricts output to products that match all of the
specified tags. Boolean operators `OR` and `NOT` are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '`-"tagA"`', which
is equivalent to '`NOT "tagA"`'. 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;value - The filter to set.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:
* `lastModifiedTime`: This can be specified twice, once with a
less than operator and once with a greater than operator. The
`lastModifiedTime` restriction should result in one, contiguous,
valid, last-modified, time range.
* `productType`: Supported values are `primary` and `variant`. The
Boolean operators `OR` and `NOT` are supported if the expression is
enclosed in parentheses and must be separated from the
`productType` values by a space.
* `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`,
`PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are
supported if the expression is enclosed in parentheses and must be
separated from the `availability` values by a space.
* `Tag expressions`: Restricts output to products that match all of the
specified tags. Boolean operators `OR` and `NOT` are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '`-"tagA"`', which
is equivalent to '`NOT "tagA"`'. 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;public ExportProductsRequest.Builder setFilterBytes(com.google.protobuf.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:
* `lastModifiedTime`: This can be specified twice, once with a
less than operator and once with a greater than operator. The
`lastModifiedTime` restriction should result in one, contiguous,
valid, last-modified, time range.
* `productType`: Supported values are `primary` and `variant`. The
Boolean operators `OR` and `NOT` are supported if the expression is
enclosed in parentheses and must be separated from the
`productType` values by a space.
* `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`,
`PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are
supported if the expression is enclosed in parentheses and must be
separated from the `availability` values by a space.
* `Tag expressions`: Restricts output to products that match all of the
specified tags. Boolean operators `OR` and `NOT` are supported if the
expression is enclosed in parentheses and the operators are separated
from the tag values by a space. Also supported is '`-"tagA"`', which
is equivalent to '`NOT "tagA"`'. 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;value - The bytes for filter to set.public final ExportProductsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>public final ExportProductsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportProductsRequest.Builder>Copyright © 2025 Google LLC. All rights reserved.