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