public static final class UpdateProductRequest.Builder extends GeneratedMessageV3.Builder<UpdateProductRequest.Builder> implements UpdateProductRequestOrBuilder
Request message for [UpdateProduct][] method.
Protobuf type google.cloud.retail.v2.UpdateProductRequest
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UpdateProductRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public UpdateProductRequest build()
Returns
buildPartial()
public UpdateProductRequest buildPartial()
Returns
clear()
public UpdateProductRequest.Builder clear()
Returns
Overrides
clearAllowMissing()
public UpdateProductRequest.Builder clearAllowMissing()
If set to true, and the Product is not
found, a new Product will be created. In
this situation, update_mask is ignored.
bool allow_missing = 3;
clearField(Descriptors.FieldDescriptor field)
public UpdateProductRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public UpdateProductRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearProduct()
public UpdateProductRequest.Builder clearProduct()
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
clearUpdateMask()
public UpdateProductRequest.Builder clearUpdateMask()
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
clone()
public UpdateProductRequest.Builder clone()
Returns
Overrides
getAllowMissing()
public boolean getAllowMissing()
If set to true, and the Product is not
found, a new Product will be created. In
this situation, update_mask is ignored.
bool allow_missing = 3;
| Type | Description |
| boolean | The allowMissing.
|
getDefaultInstanceForType()
public UpdateProductRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getProduct()
public Product getProduct()
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
getProductBuilder()
public Product.Builder getProductBuilder()
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
getProductOrBuilder()
public ProductOrBuilder getProductOrBuilder()
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
getUpdateMask()
public FieldMask getUpdateMask()
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
getUpdateMaskBuilder()
public FieldMask.Builder getUpdateMaskBuilder()
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
getUpdateMaskOrBuilder()
public FieldMaskOrBuilder getUpdateMaskOrBuilder()
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
hasProduct()
public boolean hasProduct()
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the product field is set.
|
hasUpdateMask()
public boolean hasUpdateMask()
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
| Type | Description |
| boolean | Whether the updateMask field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(UpdateProductRequest other)
public UpdateProductRequest.Builder mergeFrom(UpdateProductRequest other)
Parameter
Returns
public UpdateProductRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public UpdateProductRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeProduct(Product value)
public UpdateProductRequest.Builder mergeProduct(Product value)
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UpdateProductRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
mergeUpdateMask(FieldMask value)
public UpdateProductRequest.Builder mergeUpdateMask(FieldMask value)
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
setAllowMissing(boolean value)
public UpdateProductRequest.Builder setAllowMissing(boolean value)
If set to true, and the Product is not
found, a new Product will be created. In
this situation, update_mask is ignored.
bool allow_missing = 3;
| Name | Description |
| value | boolean
The allowMissing to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public UpdateProductRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setProduct(Product value)
public UpdateProductRequest.Builder setProduct(Product value)
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
setProduct(Product.Builder builderForValue)
public UpdateProductRequest.Builder setProduct(Product.Builder builderForValue)
Required. The product to update/create.
If the caller does not have permission to update the
Product, regardless of whether or not it
exists, a PERMISSION_DENIED error is returned.
If the Product to update does not exist
and
allow_missing
is not set, a NOT_FOUND error is returned.
.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UpdateProductRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final UpdateProductRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setUpdateMask(FieldMask value)
public UpdateProductRequest.Builder setUpdateMask(FieldMask value)
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
setUpdateMask(FieldMask.Builder builderForValue)
public UpdateProductRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)
Indicates which fields in the provided
Product to update. The immutable and
output only fields are NOT supported. If not set, all supported fields (the
fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
The attribute key can be updated by setting the mask path as
"attributes.${key_name}". If a key name is present in the mask but not in
the patching product from the request, this key will be deleted after the
update.
.google.protobuf.FieldMask update_mask = 2;
| Name | Description |
| builderForValue | Builder
|
Returns
