Package com.google.cloud.retail.v2alpha

Interface RemoveLocalInventoriesRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getAllowMissing()
      If set to true, and the [Product][google.cloud.retail.v2alpha.Product] is not found, the local inventory removal request will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2alpha.Product] is created.
      String getPlaceIds​(int index)
      Required.
      com.google.protobuf.ByteString getPlaceIdsBytes​(int index)
      Required.
      int getPlaceIdsCount()
      Required.
      List<String> getPlaceIdsList()
      Required.
      String getProduct()
      Required.
      com.google.protobuf.ByteString getProductBytes()
      Required.
      com.google.protobuf.Timestamp getRemoveTime()
      The time when the inventory deletions are issued.
      com.google.protobuf.TimestampOrBuilder getRemoveTimeOrBuilder()
      The time when the inventory deletions are issued.
      boolean hasRemoveTime()
      The time when the inventory deletions are issued.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getProduct

        String getProduct()
         Required. Full resource name of
 [Product][google.cloud.retail.v2alpha.Product], such as
 `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.

 If the caller does not have permission to access the
 [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
 not it exists, a PERMISSION_DENIED error is returned.
        string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The product.

      • getProductBytes

        com.google.protobuf.ByteString getProductBytes()
         Required. Full resource name of
 [Product][google.cloud.retail.v2alpha.Product], such as
 `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.

 If the caller does not have permission to access the
 [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
 not it exists, a PERMISSION_DENIED error is returned.
        string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for product.

      • getPlaceIdsList

        List<String> getPlaceIdsList()
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        A list containing the placeIds.

      • getPlaceIdsCount

        int getPlaceIdsCount()
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The count of placeIds.

      • getPlaceIds

        String getPlaceIds​(int index)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index of the element to return.
        Returns:
        The placeIds at the given index.

      • getPlaceIdsBytes

        com.google.protobuf.ByteString getPlaceIdsBytes​(int index)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the placeIds at the given index.

      • hasRemoveTime

        boolean hasRemoveTime()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;
        Returns:
        Whether the removeTime field is set.

      • getRemoveTime

        com.google.protobuf.Timestamp getRemoveTime()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;
        Returns:
        The removeTime.

      • getRemoveTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getRemoveTimeOrBuilder()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;

      • getAllowMissing

        boolean getAllowMissing()
         If set to true, and the [Product][google.cloud.retail.v2alpha.Product] is
 not found, the local inventory removal request will still be processed and
 retained for at most 1 day and processed once the
 [Product][google.cloud.retail.v2alpha.Product] is created. If set to false,
 a NOT_FOUND error is returned if the
 [Product][google.cloud.retail.v2alpha.Product] is not found.
        bool allow_missing = 3;
        Returns:
        The allowMissing.