Class UpdateProductRequest.Builder (2.51.0)

public static final class UpdateProductRequest.Builder extends GeneratedMessageV3.Builder<UpdateProductRequest.Builder> implements UpdateProductRequestOrBuilder

Request message for ProductService.UpdateProduct method.

Protobuf type google.cloud.retail.v2beta.UpdateProductRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateProductRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateProductRequest.Builder
Overrides

build()

public UpdateProductRequest build()
Returns
Type Description
UpdateProductRequest

buildPartial()

public UpdateProductRequest buildPartial()
Returns
Type Description
UpdateProductRequest

clear()

public UpdateProductRequest.Builder clear()
Returns
Type Description
UpdateProductRequest.Builder
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;

Returns
Type Description
UpdateProductRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UpdateProductRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateProductRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateProductRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateProductRequest.Builder
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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateProductRequest.Builder

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;

Returns
Type Description
UpdateProductRequest.Builder

clone()

public UpdateProductRequest.Builder clone()
Returns
Type Description
UpdateProductRequest.Builder
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;

Returns
Type Description
boolean

The allowMissing.

getDefaultInstanceForType()

public UpdateProductRequest getDefaultInstanceForType()
Returns
Type Description
UpdateProductRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Product

The product.

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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Product.Builder

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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductOrBuilder

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;

Returns
Type Description
FieldMask

The updateMask.

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;

Returns
Type Description
Builder

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;

Returns
Type Description
FieldMaskOrBuilder

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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
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;

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateProductRequest other)

public UpdateProductRequest.Builder mergeFrom(UpdateProductRequest other)
Parameter
Name Description
other UpdateProductRequest
Returns
Type Description
UpdateProductRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateProductRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateProductRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateProductRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateProductRequest.Builder
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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Product
Returns
Type Description
UpdateProductRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateProductRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateProductRequest.Builder
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;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateProductRequest.Builder

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;

Parameter
Name Description
value boolean

The allowMissing to set.

Returns
Type Description
UpdateProductRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateProductRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateProductRequest.Builder
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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Product
Returns
Type Description
UpdateProductRequest.Builder

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.v2beta.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Product.Builder
Returns
Type Description
UpdateProductRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateProductRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateProductRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateProductRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateProductRequest.Builder
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;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateProductRequest.Builder

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateProductRequest.Builder