Class UpdateProductRequest.Builder (2.25.0)

Version 2.25.0

• 2.55.0 (latest)
• 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 UpdateProductRequest.Builder extends GeneratedMessageV3.Builder<UpdateProductRequest.Builder> implements UpdateProductRequestOrBuilder

Request message for ProductService.UpdateProduct method.

Protobuf type google.cloud.retail.v2alpha.UpdateProductRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateProductRequest.Builder

Implements

UpdateProductRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateProductRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
UpdateProductRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.v2alpha.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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public UpdateProductRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
UpdateProductRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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.v2alpha.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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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.v2alpha.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.v2alpha.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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateProductRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
UpdateProductRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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