Package com.google.cloud.retail.v2alpha

Class ExportProductsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.ExportProductsRequest
All Implemented Interfaces:
ExportProductsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ExportProductsRequest extends com.google.protobuf.GeneratedMessage implements ExportProductsRequestOrBuilder
 Request message for ExportProducts method.
Protobuf type google.cloud.retail.v2alpha.ExportProductsRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ExportProductsRequest.Builder
    Request message for ExportProducts method.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    OUTPUT_CONFIG_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ExportProductsRequest
    getDefaultInstance()
     
    ExportProductsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    OutputConfigOrBuilder
    getOutputConfigOrBuilder()
    Required.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<ExportProductsRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasOutputConfig()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ExportProductsRequest.Builder
    newBuilder()
     
    static ExportProductsRequest.Builder
    newBuilder(ExportProductsRequest prototype)
     
    ExportProductsRequest.Builder
    newBuilderForType()
     
    protected ExportProductsRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ExportProductsRequest
    parseDelimitedFrom(InputStream input)
     
    static ExportProductsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportProductsRequest
    parseFrom(byte[] data)
     
    static ExportProductsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportProductsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ExportProductsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportProductsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ExportProductsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportProductsRequest
    parseFrom(InputStream input)
     
    static ExportProductsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportProductsRequest
    parseFrom(ByteBuffer data)
     
    static ExportProductsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ExportProductsRequest>
    parser()
     
    ExportProductsRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ExportProductsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ExportProductsRequestOrBuilder
      Returns:
      The bytes for parent.

    • hasOutputConfig

      public boolean hasOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasOutputConfig in interface ExportProductsRequestOrBuilder
      Returns:
      Whether the outputConfig field is set.

    • getOutputConfig

      public OutputConfig getOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputConfig in interface ExportProductsRequestOrBuilder
      Returns:
      The outputConfig.

    • getOutputConfigOrBuilder

      public OutputConfigOrBuilder getOutputConfigOrBuilder()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputConfigOrBuilder in interface ExportProductsRequestOrBuilder

    • 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:

 * `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;
      Specified by:
      getFilter in interface ExportProductsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ExportProductsRequestOrBuilder
      Returns:
      The bytes for filter.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExportProductsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportProductsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportProductsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportProductsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportProductsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportProductsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportProductsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportProductsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportProductsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportProductsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportProductsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportProductsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExportProductsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExportProductsRequest.Builder newBuilder()

    • newBuilder

      public static ExportProductsRequest.Builder newBuilder(ExportProductsRequest prototype)

    • toBuilder

      public ExportProductsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExportProductsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ExportProductsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExportProductsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExportProductsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ExportProductsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder