public final class RemoveFulfillmentPlacesRequest extends GeneratedMessageV3 implements RemoveFulfillmentPlacesRequestOrBuilder
Request message for [RemoveFulfillmentPlaces][] method.
Protobuf type google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest
Static Fields
ALLOW_MISSING_FIELD_NUMBER
public static final int ALLOW_MISSING_FIELD_NUMBER
Field Value
PLACE_IDS_FIELD_NUMBER
public static final int PLACE_IDS_FIELD_NUMBER
Field Value
PRODUCT_FIELD_NUMBER
public static final int PRODUCT_FIELD_NUMBER
Field Value
REMOVE_TIME_FIELD_NUMBER
public static final int REMOVE_TIME_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RemoveFulfillmentPlacesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RemoveFulfillmentPlacesRequest.Builder newBuilder()
Returns
newBuilder(RemoveFulfillmentPlacesRequest prototype)
public static RemoveFulfillmentPlacesRequest.Builder newBuilder(RemoveFulfillmentPlacesRequest prototype)
Parameter
Returns
public static RemoveFulfillmentPlacesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RemoveFulfillmentPlacesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RemoveFulfillmentPlacesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RemoveFulfillmentPlacesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RemoveFulfillmentPlacesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RemoveFulfillmentPlacesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RemoveFulfillmentPlacesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RemoveFulfillmentPlacesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RemoveFulfillmentPlacesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RemoveFulfillmentPlacesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RemoveFulfillmentPlacesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RemoveFulfillmentPlacesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RemoveFulfillmentPlacesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Type | Description |
| boolean | The allowMissing.
|
getDefaultInstanceForType()
public RemoveFulfillmentPlacesRequest getDefaultInstanceForType()
Returns
getParserForType()
public Parser<RemoveFulfillmentPlacesRequest> getParserForType()
Returns
Overrides
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];
| 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];
| 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];
| 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];
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) = { ... }
| 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) = { ... }
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;
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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];
| 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
| boolean | Whether the removeTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RemoveFulfillmentPlacesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RemoveFulfillmentPlacesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RemoveFulfillmentPlacesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
