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