- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 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 DeleteProductRequest.Builder extends GeneratedMessageV3.Builder<DeleteProductRequest.Builder> implements DeleteProductRequestOrBuilder
Request message for ProductService.DeleteProduct method.
Protobuf type google.cloud.retail.v2alpha.DeleteProductRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DeleteProductRequest.BuilderImplements
DeleteProductRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DeleteProductRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
build()
public DeleteProductRequest build()
Returns | |
---|---|
Type | Description |
DeleteProductRequest |
buildPartial()
public DeleteProductRequest buildPartial()
Returns | |
---|---|
Type | Description |
DeleteProductRequest |
clear()
public DeleteProductRequest.Builder clear()
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public DeleteProductRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
clearForce()
public DeleteProductRequest.Builder clearForce()
This value only applies to the case when the target product is of type PRIMARY. When deleting a product of VARIANT/COLLECTION type, this value will be ignored. When set to true, the subsequent variant products will be deleted. When set to false, if the primary product has active variant products, an error will be returned.
bool force = 4;
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
This builder for chaining. |
clearName()
public DeleteProductRequest.Builder clearName()
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 delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the Product to delete does not exist, a NOT_FOUND error is returned.
The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned.
All inventory information for the named Product will be deleted.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DeleteProductRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
clone()
public DeleteProductRequest.Builder clone()
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
getDefaultInstanceForType()
public DeleteProductRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
DeleteProductRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getForce()
public boolean getForce()
This value only applies to the case when the target product is of type PRIMARY. When deleting a product of VARIANT/COLLECTION type, this value will be ignored. When set to true, the subsequent variant products will be deleted. When set to false, if the primary product has active variant products, an error will be returned.
bool force = 4;
Returns | |
---|---|
Type | Description |
boolean |
The force. |
getName()
public String getName()
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 delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the Product to delete does not exist, a NOT_FOUND error is returned.
The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned.
All inventory information for the named Product will be deleted.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
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 delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the Product to delete does not exist, a NOT_FOUND error is returned.
The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned.
All inventory information for the named Product will be deleted.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(DeleteProductRequest other)
public DeleteProductRequest.Builder mergeFrom(DeleteProductRequest other)
Parameter | |
---|---|
Name | Description |
other |
DeleteProductRequest |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DeleteProductRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public DeleteProductRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DeleteProductRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public DeleteProductRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
setForce(boolean value)
public DeleteProductRequest.Builder setForce(boolean value)
This value only applies to the case when the target product is of type PRIMARY. When deleting a product of VARIANT/COLLECTION type, this value will be ignored. When set to true, the subsequent variant products will be deleted. When set to false, if the primary product has active variant products, an error will be returned.
bool force = 4;
Parameter | |
---|---|
Name | Description |
value |
boolean The force to set. |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
This builder for chaining. |
setName(String value)
public DeleteProductRequest.Builder setName(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 delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the Product to delete does not exist, a NOT_FOUND error is returned.
The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned.
All inventory information for the named Product will be deleted.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public DeleteProductRequest.Builder setNameBytes(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 delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the Product to delete does not exist, a NOT_FOUND error is returned.
The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned.
All inventory information for the named Product will be deleted.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DeleteProductRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final DeleteProductRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
DeleteProductRequest.Builder |