- 2.49.0 (latest)
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class RemoveFulfillmentPlacesRequest.Builder extends GeneratedMessageV3.Builder<RemoveFulfillmentPlacesRequest.Builder> implements RemoveFulfillmentPlacesRequestOrBuilder
Request message for ProductService.RemoveFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RemoveFulfillmentPlacesRequest.BuilderImplements
RemoveFulfillmentPlacesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllPlaceIds(Iterable<String> values)
public RemoveFulfillmentPlacesRequest.Builder addAllPlaceIds(Iterable<String> values)
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
values | Iterable<String> The placeIds to add. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
addPlaceIds(String value)
public RemoveFulfillmentPlacesRequest.Builder addPlaceIds(String value)
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | String The placeIds to add. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
addPlaceIdsBytes(ByteString value)
public RemoveFulfillmentPlacesRequest.Builder addPlaceIdsBytes(ByteString value)
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes of the placeIds to add. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RemoveFulfillmentPlacesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
build()
public RemoveFulfillmentPlacesRequest build()
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest |
buildPartial()
public RemoveFulfillmentPlacesRequest buildPartial()
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest |
clear()
public RemoveFulfillmentPlacesRequest.Builder clear()
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
clearAllowMissing()
public RemoveFulfillmentPlacesRequest.Builder clearAllowMissing()
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.
bool allow_missing = 5;
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public RemoveFulfillmentPlacesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RemoveFulfillmentPlacesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
clearPlaceIds()
public RemoveFulfillmentPlacesRequest.Builder clearPlaceIds()
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
clearProduct()
public RemoveFulfillmentPlacesRequest.Builder clearProduct()
Required. Full resource name of
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, 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 | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
clearRemoveTime()
public RemoveFulfillmentPlacesRequest.Builder clearRemoveTime()
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.
.google.protobuf.Timestamp remove_time = 4;
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
clearType()
public RemoveFulfillmentPlacesRequest.Builder clearType()
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.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
clone()
public RemoveFulfillmentPlacesRequest.Builder clone()
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
getAllowMissing()
public boolean getAllowMissing()
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.
bool allow_missing = 5;
Returns | |
---|---|
Type | Description |
boolean | The allowMissing. |
getDefaultInstanceForType()
public RemoveFulfillmentPlacesRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getPlaceIds(int index)
public String getPlaceIds(int index)
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The placeIds at the given index. |
getPlaceIdsBytes(int index)
public ByteString getPlaceIdsBytes(int index)
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the placeIds at the given index. |
getPlaceIdsCount()
public int getPlaceIdsCount()
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int | The count of placeIds. |
getPlaceIdsList()
public ProtocolStringList getPlaceIdsList()
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the placeIds. |
getProduct()
public String getProduct()
Required. Full resource name of
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, 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 | |
---|---|
Type | Description |
String | The product. |
getProductBytes()
public ByteString getProductBytes()
Required. Full resource name of
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, 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 | |
---|---|
Type | Description |
ByteString | The bytes for product. |
getRemoveTime()
public Timestamp getRemoveTime()
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.
.google.protobuf.Timestamp remove_time = 4;
Returns | |
---|---|
Type | Description |
Timestamp | The removeTime. |
getRemoveTimeBuilder()
public Timestamp.Builder getRemoveTimeBuilder()
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.
.google.protobuf.Timestamp remove_time = 4;
Returns | |
---|---|
Type | Description |
Builder |
getRemoveTimeOrBuilder()
public TimestampOrBuilder getRemoveTimeOrBuilder()
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.
.google.protobuf.Timestamp remove_time = 4;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getType()
public String getType()
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.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String | The type. |
getTypeBytes()
public ByteString getTypeBytes()
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.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for type. |
hasRemoveTime()
public boolean hasRemoveTime()
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.
.google.protobuf.Timestamp remove_time = 4;
Returns | |
---|---|
Type | Description |
boolean | Whether the removeTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(RemoveFulfillmentPlacesRequest other)
public RemoveFulfillmentPlacesRequest.Builder mergeFrom(RemoveFulfillmentPlacesRequest other)
Parameter | |
---|---|
Name | Description |
other | RemoveFulfillmentPlacesRequest |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RemoveFulfillmentPlacesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RemoveFulfillmentPlacesRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
mergeRemoveTime(Timestamp value)
public RemoveFulfillmentPlacesRequest.Builder mergeRemoveTime(Timestamp value)
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.
.google.protobuf.Timestamp remove_time = 4;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RemoveFulfillmentPlacesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
setAllowMissing(boolean value)
public RemoveFulfillmentPlacesRequest.Builder setAllowMissing(boolean value)
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.
bool allow_missing = 5;
Parameter | |
---|---|
Name | Description |
value | boolean The allowMissing to set. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public RemoveFulfillmentPlacesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
setPlaceIds(int index, String value)
public RemoveFulfillmentPlacesRequest.Builder setPlaceIds(int index, String value)
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.
repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The placeIds to set. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
setProduct(String value)
public RemoveFulfillmentPlacesRequest.Builder setProduct(String value)
Required. Full resource name of
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, 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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The product to set. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
setProductBytes(ByteString value)
public RemoveFulfillmentPlacesRequest.Builder setProductBytes(ByteString value)
Required. Full resource name of
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, 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) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for product to set. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
setRemoveTime(Timestamp value)
public RemoveFulfillmentPlacesRequest.Builder setRemoveTime(Timestamp value)
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.
.google.protobuf.Timestamp remove_time = 4;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
setRemoveTime(Timestamp.Builder builderForValue)
public RemoveFulfillmentPlacesRequest.Builder setRemoveTime(Timestamp.Builder builderForValue)
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.
.google.protobuf.Timestamp remove_time = 4;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RemoveFulfillmentPlacesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |
setType(String value)
public RemoveFulfillmentPlacesRequest.Builder setType(String value)
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.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | String The type to set. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
setTypeBytes(ByteString value)
public RemoveFulfillmentPlacesRequest.Builder setTypeBytes(ByteString value)
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.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for type to set. |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RemoveFulfillmentPlacesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RemoveFulfillmentPlacesRequest.Builder |