Package com.google.cloud.retail.v2alpha

Class ExportProductsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ExportProductsRequest.Builder>
com.google.cloud.retail.v2alpha.ExportProductsRequest.Builder
All Implemented Interfaces:
ExportProductsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExportProductsRequest
public static final class ExportProductsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ExportProductsRequest.Builder> implements ExportProductsRequestOrBuilder
 Request message for ExportProducts method.
Protobuf type google.cloud.retail.v2alpha.ExportProductsRequest

  • 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.Builder<ExportProductsRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ExportProductsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ExportProductsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportProductsRequest.Builder>

    • mergeFrom

      public ExportProductsRequest.Builder mergeFrom(ExportProductsRequest other)

    • isInitialized

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

    • mergeFrom

      public ExportProductsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportProductsRequest.Builder>
      Throws:
      IOException

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

    • setParent

      public 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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      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) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

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

    • setOutputConfig

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

    • setOutputConfig

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

    • mergeOutputConfig

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

    • clearOutputConfig

      public ExportProductsRequest.Builder clearOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

    • getOutputConfigBuilder

      public OutputConfig.Builder getOutputConfigBuilder()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

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

    • setFilter

      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:

 * `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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

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

 * `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;
      Returns:
      This builder for chaining.

    • setFilterBytes

      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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.