Class: Google::Apis::RetailV2::GoogleCloudRetailV2RemoveFulfillmentPlacesRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

Request message for ProductService.RemoveFulfillmentPlaces method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2RemoveFulfillmentPlacesRequest

Returns a new instance of GoogleCloudRetailV2RemoveFulfillmentPlacesRequest.



4180
4181
4182
# File 'lib/google/apis/retail_v2/classes.rb', line 4180

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_missingBoolean Also known as: allow_missing?

If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found. Corresponds to the JSON property allowMissing

Returns:

  • (Boolean)


4149
4150
4151
# File 'lib/google/apis/retail_v2/classes.rb', line 4149

def allow_missing
  @allow_missing
end

#place_idsArray<String>

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery", to be removed for this type. At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property placeIds

Returns:

  • (Array<String>)


4160
4161
4162
# File 'lib/google/apis/retail_v2/classes.rb', line 4160

def place_ids
  @place_ids
end

#remove_timeString

The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used. Corresponds to the JSON property removeTime

Returns:

  • (String)


4167
4168
4169
# File 'lib/google/apis/retail_v2/classes.rb', line 4167

def remove_time
  @remove_time
end

#typeString

Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Supported values: * "pickup- in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * " custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom- type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. This field directly corresponds to Product. fulfillment_info.type. Corresponds to the JSON property type

Returns:

  • (String)


4178
4179
4180
# File 'lib/google/apis/retail_v2/classes.rb', line 4178

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4185
4186
4187
4188
4189
4190
# File 'lib/google/apis/retail_v2/classes.rb', line 4185

def update!(**args)
  @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
  @place_ids = args[:place_ids] if args.key?(:place_ids)
  @remove_time = args[:remove_time] if args.key?(:remove_time)
  @type = args[:type] if args.key?(:type)
end