Class ExportProductsRequest (2.54.0) 

public final class ExportProductsRequest extends GeneratedMessageV3 implements ExportProductsRequestOrBuilder

Request message for ExportProducts method.

Protobuf type google.cloud.retail.v2beta.ExportProductsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExportProductsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportProductsRequest getDefaultInstance()
Returns
Type Description
ExportProductsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExportProductsRequest.Builder newBuilder()
Returns
Type Description
ExportProductsRequest.Builder

newBuilder(ExportProductsRequest prototype)

public static ExportProductsRequest.Builder newBuilder(ExportProductsRequest prototype)
Parameter
Name Description
prototype ExportProductsRequest
Returns
Type Description
ExportProductsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExportProductsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExportProductsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportProductsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportProductsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExportProductsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExportProductsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExportProductsRequest> parser()
Returns
Type Description
Parser<ExportProductsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExportProductsRequest getDefaultInstanceForType()
Returns
Type Description
ExportProductsRequest

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.

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.

getParserForType()

public Parser<ExportProductsRequest> getParserForType()
Returns
Type Description
Parser<ExportProductsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExportProductsRequest.Builder newBuilderForType()
Returns
Type Description
ExportProductsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExportProductsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExportProductsRequest.Builder toBuilder()
Returns
Type Description
ExportProductsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException