public final class UpdateProductRequest extends GeneratedMessageV3 implements UpdateProductRequestOrBuilder
Request message for
ProductService.UpdateProduct
method.
Protobuf type google.cloud.retail.v2.UpdateProductRequest
Static Fields
ALLOW_MISSING_FIELD_NUMBER
public static final int ALLOW_MISSING_FIELD_NUMBER
Field Value
PRODUCT_FIELD_NUMBER
public static final int PRODUCT_FIELD_NUMBER
Field Value
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static UpdateProductRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static UpdateProductRequest.Builder newBuilder()
Returns
newBuilder(UpdateProductRequest prototype)
public static UpdateProductRequest.Builder newBuilder(UpdateProductRequest prototype)
Parameter
Returns
public static UpdateProductRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static UpdateProductRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static UpdateProductRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateProductRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static UpdateProductRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateProductRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UpdateProductRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static UpdateProductRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UpdateProductRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static UpdateProductRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static UpdateProductRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateProductRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<UpdateProductRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
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
getParserForType()
public Parser<UpdateProductRequest> getParserForType()
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];
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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public UpdateProductRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateProductRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public UpdateProductRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
