Package com.google.cloud.retail.v2alpha

Class PurgeProductsRequest.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • clear

        public PurgeProductsRequest.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.GeneratedMessageV3.Builder<PurgeProductsRequest.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.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public PurgeProductsRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • setField

        public PurgeProductsRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • clearField

        public PurgeProductsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • clearOneof

        public PurgeProductsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • setRepeatedField

        public PurgeProductsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • addRepeatedField

        public PurgeProductsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public PurgeProductsRequest.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<PurgeProductsRequest.Builder>
        Throws:
        IOException

      • getParent

        public String getParent()
         Required. The resource name of the branch under which the products are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface PurgeProductsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the branch under which the products are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface PurgeProductsRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public PurgeProductsRequest.Builder setParent​(String value)
         Required. The resource name of the branch under which the products are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
        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 PurgeProductsRequest.Builder clearParent()
         Required. The resource name of the branch under which the products are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public PurgeProductsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the branch under which the products are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
        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.

      • getFilter

        public String getFilter()
         Required. The filter string to specify the products to be deleted with a
 length limit of 5,000 characters.

 Empty string filter is not allowed. "*" implies delete all items in a
 branch.

 The eligible fields for filtering are:

 * `availability`: Double quoted
 [Product.availability][google.cloud.retail.v2alpha.Product.availability]
 string.
 * `create_time` : in ISO 8601 "zulu" format.

 Supported syntax:

 * Comparators (">", "<", ">=", "<=", "=").
   Examples:
   * create_time <= "2015-02-13T17:05:46Z"
   * availability = "IN_STOCK"

 * Conjunctions ("AND")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

 * Disjunctions ("OR")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

 * Can support nested queries.
   Examples:
   * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
   OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

 * Filter Limits:
   * Filter should not contain more than 6 conditions.
   * Max nesting depth should not exceed 2 levels.

 Examples queries:
 * Delete back order products created before a timestamp.
   create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilter in interface PurgeProductsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Required. The filter string to specify the products to be deleted with a
 length limit of 5,000 characters.

 Empty string filter is not allowed. "*" implies delete all items in a
 branch.

 The eligible fields for filtering are:

 * `availability`: Double quoted
 [Product.availability][google.cloud.retail.v2alpha.Product.availability]
 string.
 * `create_time` : in ISO 8601 "zulu" format.

 Supported syntax:

 * Comparators (">", "<", ">=", "<=", "=").
   Examples:
   * create_time <= "2015-02-13T17:05:46Z"
   * availability = "IN_STOCK"

 * Conjunctions ("AND")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

 * Disjunctions ("OR")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

 * Can support nested queries.
   Examples:
   * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
   OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

 * Filter Limits:
   * Filter should not contain more than 6 conditions.
   * Max nesting depth should not exceed 2 levels.

 Examples queries:
 * Delete back order products created before a timestamp.
   create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilterBytes in interface PurgeProductsRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public PurgeProductsRequest.Builder setFilter​(String value)
         Required. The filter string to specify the products to be deleted with a
 length limit of 5,000 characters.

 Empty string filter is not allowed. "*" implies delete all items in a
 branch.

 The eligible fields for filtering are:

 * `availability`: Double quoted
 [Product.availability][google.cloud.retail.v2alpha.Product.availability]
 string.
 * `create_time` : in ISO 8601 "zulu" format.

 Supported syntax:

 * Comparators (">", "<", ">=", "<=", "=").
   Examples:
   * create_time <= "2015-02-13T17:05:46Z"
   * availability = "IN_STOCK"

 * Conjunctions ("AND")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

 * Disjunctions ("OR")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

 * Can support nested queries.
   Examples:
   * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
   OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

 * Filter Limits:
   * Filter should not contain more than 6 conditions.
   * Max nesting depth should not exceed 2 levels.

 Examples queries:
 * Delete back order products created before a timestamp.
   create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public PurgeProductsRequest.Builder clearFilter()
         Required. The filter string to specify the products to be deleted with a
 length limit of 5,000 characters.

 Empty string filter is not allowed. "*" implies delete all items in a
 branch.

 The eligible fields for filtering are:

 * `availability`: Double quoted
 [Product.availability][google.cloud.retail.v2alpha.Product.availability]
 string.
 * `create_time` : in ISO 8601 "zulu" format.

 Supported syntax:

 * Comparators (">", "<", ">=", "<=", "=").
   Examples:
   * create_time <= "2015-02-13T17:05:46Z"
   * availability = "IN_STOCK"

 * Conjunctions ("AND")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

 * Disjunctions ("OR")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

 * Can support nested queries.
   Examples:
   * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
   OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

 * Filter Limits:
   * Filter should not contain more than 6 conditions.
   * Max nesting depth should not exceed 2 levels.

 Examples queries:
 * Delete back order products created before a timestamp.
   create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setFilterBytes

        public PurgeProductsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Required. The filter string to specify the products to be deleted with a
 length limit of 5,000 characters.

 Empty string filter is not allowed. "*" implies delete all items in a
 branch.

 The eligible fields for filtering are:

 * `availability`: Double quoted
 [Product.availability][google.cloud.retail.v2alpha.Product.availability]
 string.
 * `create_time` : in ISO 8601 "zulu" format.

 Supported syntax:

 * Comparators (">", "<", ">=", "<=", "=").
   Examples:
   * create_time <= "2015-02-13T17:05:46Z"
   * availability = "IN_STOCK"

 * Conjunctions ("AND")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

 * Disjunctions ("OR")
   Examples:
   * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

 * Can support nested queries.
   Examples:
   * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
   OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

 * Filter Limits:
   * Filter should not contain more than 6 conditions.
   * Max nesting depth should not exceed 2 levels.

 Examples queries:
 * Delete back order products created before a timestamp.
   create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • getForce

        public boolean getForce()
         Actually perform the purge.
 If `force` is set to false, the method will return the expected purge count
 without deleting any products.
        bool force = 3;
        Specified by:
        getForce in interface PurgeProductsRequestOrBuilder
        Returns:
        The force.

      • setForce

        public PurgeProductsRequest.Builder setForce​(boolean value)
         Actually perform the purge.
 If `force` is set to false, the method will return the expected purge count
 without deleting any products.
        bool force = 3;
        Parameters:
        value - The force to set.
        Returns:
        This builder for chaining.

      • clearForce

        public PurgeProductsRequest.Builder clearForce()
         Actually perform the purge.
 If `force` is set to false, the method will return the expected purge count
 without deleting any products.
        bool force = 3;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final PurgeProductsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>

      • mergeUnknownFields

        public final PurgeProductsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>