Package com.google.cloud.recommendationengine.v1beta1

Class PredictRequest.Builder

  • All Implemented Interfaces:
    PredictRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    PredictRequest
    public static final class PredictRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
implements PredictRequestOrBuilder
     Request message for Predict method.
    Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest

    • Method Detail

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>

      • internalGetFieldAccessorTable

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

      • clear

        public PredictRequest.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<PredictRequest.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<PredictRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public PredictRequest.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<PredictRequest.Builder>

      • setField

        public PredictRequest.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<PredictRequest.Builder>

      • clearField

        public PredictRequest.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<PredictRequest.Builder>

      • clearOneof

        public PredictRequest.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<PredictRequest.Builder>

      • setRepeatedField

        public PredictRequest.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<PredictRequest.Builder>

      • addRepeatedField

        public PredictRequest.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<PredictRequest.Builder>

      • mergeFrom

        public PredictRequest.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<PredictRequest.Builder>

      • isInitialized

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

      • mergeFrom

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

      • getName

        public String getName()
         Required. Full resource name of the format:
 `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 The id of the recommendation engine placement. This id is used to identify
 the set of models that will be used to make the prediction.

 We currently support three placements with the following IDs by default:

 * `shopping_cart`: Predicts items frequently bought together with one or
   more catalog items in the same shopping session. Commonly displayed after
   `add-to-cart` events, on product detail pages, or on the shopping cart
   page.

 * `home_page`: Predicts the next product that a user will most likely
   engage with or purchase based on the shopping or viewing history of the
   specified `userId` or `visitorId`. For example - Recommendations for you.

 * `product_detail`: Predicts the next product that a user will most likely
   engage with or purchase. The prediction is based on the shopping or
   viewing history of the specified `userId` or `visitorId` and its
   relevance to a specified `CatalogItem`. Typically used on product detail
   pages. For example - More items like this.

 * `recently_viewed_default`: Returns up to 75 items recently viewed by the
   specified `userId` or `visitorId`, most recent ones first. Returns
   nothing if neither of them has viewed any items yet. For example -
   Recently viewed.

 The full list of available placements can be seen at
 https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface PredictRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. Full resource name of the format:
 `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 The id of the recommendation engine placement. This id is used to identify
 the set of models that will be used to make the prediction.

 We currently support three placements with the following IDs by default:

 * `shopping_cart`: Predicts items frequently bought together with one or
   more catalog items in the same shopping session. Commonly displayed after
   `add-to-cart` events, on product detail pages, or on the shopping cart
   page.

 * `home_page`: Predicts the next product that a user will most likely
   engage with or purchase based on the shopping or viewing history of the
   specified `userId` or `visitorId`. For example - Recommendations for you.

 * `product_detail`: Predicts the next product that a user will most likely
   engage with or purchase. The prediction is based on the shopping or
   viewing history of the specified `userId` or `visitorId` and its
   relevance to a specified `CatalogItem`. Typically used on product detail
   pages. For example - More items like this.

 * `recently_viewed_default`: Returns up to 75 items recently viewed by the
   specified `userId` or `visitorId`, most recent ones first. Returns
   nothing if neither of them has viewed any items yet. For example -
   Recently viewed.

 The full list of available placements can be seen at
 https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface PredictRequestOrBuilder
        Returns:
        The bytes for name.

      • setName

        public PredictRequest.Builder setName​(String value)
         Required. Full resource name of the format:
 `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 The id of the recommendation engine placement. This id is used to identify
 the set of models that will be used to make the prediction.

 We currently support three placements with the following IDs by default:

 * `shopping_cart`: Predicts items frequently bought together with one or
   more catalog items in the same shopping session. Commonly displayed after
   `add-to-cart` events, on product detail pages, or on the shopping cart
   page.

 * `home_page`: Predicts the next product that a user will most likely
   engage with or purchase based on the shopping or viewing history of the
   specified `userId` or `visitorId`. For example - Recommendations for you.

 * `product_detail`: Predicts the next product that a user will most likely
   engage with or purchase. The prediction is based on the shopping or
   viewing history of the specified `userId` or `visitorId` and its
   relevance to a specified `CatalogItem`. Typically used on product detail
   pages. For example - More items like this.

 * `recently_viewed_default`: Returns up to 75 items recently viewed by the
   specified `userId` or `visitorId`, most recent ones first. Returns
   nothing if neither of them has viewed any items yet. For example -
   Recently viewed.

 The full list of available placements can be seen at
 https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public PredictRequest.Builder clearName()
         Required. Full resource name of the format:
 `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 The id of the recommendation engine placement. This id is used to identify
 the set of models that will be used to make the prediction.

 We currently support three placements with the following IDs by default:

 * `shopping_cart`: Predicts items frequently bought together with one or
   more catalog items in the same shopping session. Commonly displayed after
   `add-to-cart` events, on product detail pages, or on the shopping cart
   page.

 * `home_page`: Predicts the next product that a user will most likely
   engage with or purchase based on the shopping or viewing history of the
   specified `userId` or `visitorId`. For example - Recommendations for you.

 * `product_detail`: Predicts the next product that a user will most likely
   engage with or purchase. The prediction is based on the shopping or
   viewing history of the specified `userId` or `visitorId` and its
   relevance to a specified `CatalogItem`. Typically used on product detail
   pages. For example - More items like this.

 * `recently_viewed_default`: Returns up to 75 items recently viewed by the
   specified `userId` or `visitorId`, most recent ones first. Returns
   nothing if neither of them has viewed any items yet. For example -
   Recently viewed.

 The full list of available placements can be seen at
 https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setNameBytes

        public PredictRequest.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Required. Full resource name of the format:
 `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 The id of the recommendation engine placement. This id is used to identify
 the set of models that will be used to make the prediction.

 We currently support three placements with the following IDs by default:

 * `shopping_cart`: Predicts items frequently bought together with one or
   more catalog items in the same shopping session. Commonly displayed after
   `add-to-cart` events, on product detail pages, or on the shopping cart
   page.

 * `home_page`: Predicts the next product that a user will most likely
   engage with or purchase based on the shopping or viewing history of the
   specified `userId` or `visitorId`. For example - Recommendations for you.

 * `product_detail`: Predicts the next product that a user will most likely
   engage with or purchase. The prediction is based on the shopping or
   viewing history of the specified `userId` or `visitorId` and its
   relevance to a specified `CatalogItem`. Typically used on product detail
   pages. For example - More items like this.

 * `recently_viewed_default`: Returns up to 75 items recently viewed by the
   specified `userId` or `visitorId`, most recent ones first. Returns
   nothing if neither of them has viewed any items yet. For example -
   Recently viewed.

 The full list of available placements can be seen at
 https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasUserEvent

        public boolean hasUserEvent()
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasUserEvent in interface PredictRequestOrBuilder
        Returns:
        Whether the userEvent field is set.

      • getUserEvent

        public UserEvent getUserEvent()
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUserEvent in interface PredictRequestOrBuilder
        Returns:
        The userEvent.

      • setUserEvent

        public PredictRequest.Builder setUserEvent​(UserEvent value)
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

      • setUserEvent

        public PredictRequest.Builder setUserEvent​(UserEvent.Builder builderForValue)
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

      • mergeUserEvent

        public PredictRequest.Builder mergeUserEvent​(UserEvent value)
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

      • clearUserEvent

        public PredictRequest.Builder clearUserEvent()
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

      • getUserEventBuilder

        public UserEvent.Builder getUserEventBuilder()
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

      • getUserEventOrBuilder

        public UserEventOrBuilder getUserEventOrBuilder()
         Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
        .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUserEventOrBuilder in interface PredictRequestOrBuilder

      • getPageSize

        public int getPageSize()
         Optional. Maximum number of results to return per page. Set this property
 to the number of prediction results required. If zero, the service will
 choose a reasonable default.
        int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface PredictRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public PredictRequest.Builder setPageSize​(int value)
         Optional. Maximum number of results to return per page. Set this property
 to the number of prediction results required. If zero, the service will
 choose a reasonable default.
        int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public PredictRequest.Builder clearPageSize()
         Optional. Maximum number of results to return per page. Set this property
 to the number of prediction results required. If zero, the service will
 choose a reasonable default.
        int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         Optional. The previous PredictResponse.next_page_token.
        string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface PredictRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. The previous PredictResponse.next_page_token.
        string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface PredictRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public PredictRequest.Builder setPageToken​(String value)
         Optional. The previous PredictResponse.next_page_token.
        string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public PredictRequest.Builder clearPageToken()
         Optional. The previous PredictResponse.next_page_token.
        string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public PredictRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Optional. The previous PredictResponse.next_page_token.
        string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • getFilter

        public String getFilter()
         Optional. Filter for restricting prediction results. Accepts values for
 tags and the `filterOutOfStockItems` flag.

  * Tag expressions. Restricts predictions to items that match all of the
    specified tags. Boolean operators `OR` and `NOT` are supported if the
    expression is enclosed in parentheses, and must be separated from the
    tag values by a space. `-"tagA"` is also supported and is equivalent to
    `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
    with a size limit of 1 KiB.

  * filterOutOfStockItems. Restricts predictions to items that do not have a
    stockState value of OUT_OF_STOCK.

 Examples:

  * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
  * filterOutOfStockItems  tag=(-"promotional")
  * filterOutOfStockItems
        string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface PredictRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. Filter for restricting prediction results. Accepts values for
 tags and the `filterOutOfStockItems` flag.

  * Tag expressions. Restricts predictions to items that match all of the
    specified tags. Boolean operators `OR` and `NOT` are supported if the
    expression is enclosed in parentheses, and must be separated from the
    tag values by a space. `-"tagA"` is also supported and is equivalent to
    `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
    with a size limit of 1 KiB.

  * filterOutOfStockItems. Restricts predictions to items that do not have a
    stockState value of OUT_OF_STOCK.

 Examples:

  * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
  * filterOutOfStockItems  tag=(-"promotional")
  * filterOutOfStockItems
        string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface PredictRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public PredictRequest.Builder setFilter​(String value)
         Optional. Filter for restricting prediction results. Accepts values for
 tags and the `filterOutOfStockItems` flag.

  * Tag expressions. Restricts predictions to items that match all of the
    specified tags. Boolean operators `OR` and `NOT` are supported if the
    expression is enclosed in parentheses, and must be separated from the
    tag values by a space. `-"tagA"` is also supported and is equivalent to
    `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
    with a size limit of 1 KiB.

  * filterOutOfStockItems. Restricts predictions to items that do not have a
    stockState value of OUT_OF_STOCK.

 Examples:

  * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
  * filterOutOfStockItems  tag=(-"promotional")
  * filterOutOfStockItems
        string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public PredictRequest.Builder clearFilter()
         Optional. Filter for restricting prediction results. Accepts values for
 tags and the `filterOutOfStockItems` flag.

  * Tag expressions. Restricts predictions to items that match all of the
    specified tags. Boolean operators `OR` and `NOT` are supported if the
    expression is enclosed in parentheses, and must be separated from the
    tag values by a space. `-"tagA"` is also supported and is equivalent to
    `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
    with a size limit of 1 KiB.

  * filterOutOfStockItems. Restricts predictions to items that do not have a
    stockState value of OUT_OF_STOCK.

 Examples:

  * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
  * filterOutOfStockItems  tag=(-"promotional")
  * filterOutOfStockItems
        string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setFilterBytes

        public PredictRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Optional. Filter for restricting prediction results. Accepts values for
 tags and the `filterOutOfStockItems` flag.

  * Tag expressions. Restricts predictions to items that match all of the
    specified tags. Boolean operators `OR` and `NOT` are supported if the
    expression is enclosed in parentheses, and must be separated from the
    tag values by a space. `-"tagA"` is also supported and is equivalent to
    `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
    with a size limit of 1 KiB.

  * filterOutOfStockItems. Restricts predictions to items that do not have a
    stockState value of OUT_OF_STOCK.

 Examples:

  * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
  * filterOutOfStockItems  tag=(-"promotional")
  * filterOutOfStockItems
        string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • getDryRun

        public boolean getDryRun()
         Optional. Use dryRun mode for this prediction query. If set to true, a
 dummy model will be used that returns arbitrary catalog items.
 Note that the dryRun mode should only be used for testing the API, or if
 the model is not ready.
        bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDryRun in interface PredictRequestOrBuilder
        Returns:
        The dryRun.

      • setDryRun

        public PredictRequest.Builder setDryRun​(boolean value)
         Optional. Use dryRun mode for this prediction query. If set to true, a
 dummy model will be used that returns arbitrary catalog items.
 Note that the dryRun mode should only be used for testing the API, or if
 the model is not ready.
        bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The dryRun to set.
        Returns:
        This builder for chaining.

      • clearDryRun

        public PredictRequest.Builder clearDryRun()
         Optional. Use dryRun mode for this prediction query. If set to true, a
 dummy model will be used that returns arbitrary catalog items.
 Note that the dryRun mode should only be used for testing the API, or if
 the model is not ready.
        bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getParamsCount

        public int getParamsCount()
        Description copied from interface: PredictRequestOrBuilder
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getParamsCount in interface PredictRequestOrBuilder

      • containsParams

        public boolean containsParams​(String key)
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsParams in interface PredictRequestOrBuilder

      • getParamsMap

        public Map<String,​com.google.protobuf.Value> getParamsMap()
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getParamsMap in interface PredictRequestOrBuilder

      • getParamsOrDefault

        public com.google.protobuf.Value getParamsOrDefault​(String key,
                                                    com.google.protobuf.Value defaultValue)
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getParamsOrDefault in interface PredictRequestOrBuilder

      • getParamsOrThrow

        public com.google.protobuf.Value getParamsOrThrow​(String key)
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getParamsOrThrow in interface PredictRequestOrBuilder

      • removeParams

        public PredictRequest.Builder removeParams​(String key)
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getMutableParams

        @Deprecated
public Map<String,​com.google.protobuf.Value> getMutableParams()
        Deprecated.
        Use alternate mutation accessors instead.

      • putParams

        public PredictRequest.Builder putParams​(String key,
                                        com.google.protobuf.Value value)
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

      • putAllParams

        public PredictRequest.Builder putAllParams​(Map<String,​com.google.protobuf.Value> values)
         Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
    object will be returned in the
   `PredictResponse.PredictionResult.itemMetadata` object in the method
    response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned item will be set in the `metadata`
    field in the prediction response. The given 'score' indicates the
    probability of an item being clicked/purchased given the user's context
    and history.
        map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: PredictRequestOrBuilder
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface PredictRequestOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface PredictRequestOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface PredictRequestOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface PredictRequestOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface PredictRequestOrBuilder

      • removeLabels

        public PredictRequest.Builder removeLabels​(String key)
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getMutableLabels

        @Deprecated
public Map<String,​String> getMutableLabels()
        Deprecated.
        Use alternate mutation accessors instead.

      • putLabels

        public PredictRequest.Builder putLabels​(String key,
                                        String value)
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

      • putAllLabels

        public PredictRequest.Builder putAllLabels​(Map<String,​String> values)
         Optional. The labels for the predict request.

  * Label keys can contain lowercase letters, digits and hyphens, must start
    with a letter, and must end with a letter or digit.
  * Non-zero label values can contain lowercase letters, digits and hyphens,
    must start with a letter, and must end with a letter or digit.
  * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
        map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

      • setUnknownFields

        public final PredictRequest.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<PredictRequest.Builder>

      • mergeUnknownFields

        public final PredictRequest.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<PredictRequest.Builder>