Class UpdateProductRequest.Builder (2.2.1)

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

Request message for [UpdateProduct][] method.

Protobuf type google.cloud.retail.v2beta.UpdateProductRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateProductRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateProductRequest.Builder
Overrides

build()

public UpdateProductRequest build()
Returns
TypeDescription
UpdateProductRequest

buildPartial()

public UpdateProductRequest buildPartial()
Returns
TypeDescription
UpdateProductRequest

clear()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UpdateProductRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UpdateProductRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateProductRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
UpdateProductRequest.Builder

clone()

public UpdateProductRequest.Builder clone()
Returns
TypeDescription
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
TypeDescription
boolean

The allowMissing.

getDefaultInstanceForType()

public UpdateProductRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateProductRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
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
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(UpdateProductRequest other)

public UpdateProductRequest.Builder mergeFrom(UpdateProductRequest other)
Parameter
NameDescription
otherUpdateProductRequest
Returns
TypeDescription
UpdateProductRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateProductRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateProductRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UpdateProductRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueProduct
Returns
TypeDescription
UpdateProductRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateProductRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
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
NameDescription
valueboolean

The allowMissing to set.

Returns
TypeDescription
UpdateProductRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateProductRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueProduct
Returns
TypeDescription
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
NameDescription
builderForValueProduct.Builder
Returns
TypeDescription
UpdateProductRequest.Builder

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

public UpdateProductRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateProductRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateProductRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
UpdateProductRequest.Builder