com.google.cloud.retail.v2

Interface UpdateProductRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UpdateProductRequest, UpdateProductRequest.Builder

public interface UpdateProductRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowMissing() If set to true, and the [Product][google.cloud.retail.v2.Product] is not found, a new [Product][google.cloud.retail.v2.Product] will be created.
Product	getProduct() Required.
ProductOrBuilder	getProductOrBuilder() Required.
com.google.protobuf.FieldMask	getUpdateMask() Indicates which fields in the provided [Product][google.cloud.retail.v2.Product] to update.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Indicates which fields in the provided [Product][google.cloud.retail.v2.Product] to update.
boolean	hasProduct() Required.
boolean	hasUpdateMask() Indicates which fields in the provided [Product][google.cloud.retail.v2.Product] to update.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasProduct

boolean hasProduct()

 Required. The product to update/create.

 If the caller does not have permission to update the
 [Product][google.cloud.retail.v2.Product], regardless of whether or not it
 exists, a PERMISSION_DENIED error is returned.

 If the [Product][google.cloud.retail.v2.Product] to update does not exist
 and
 [allow_missing][google.cloud.retail.v2.UpdateProductRequest.allow_missing]
 is not set, a NOT_FOUND error is returned.
 

.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the product field is set.

getProduct

Product getProduct()

 Required. The product to update/create.

 If the caller does not have permission to update the
 [Product][google.cloud.retail.v2.Product], regardless of whether or not it
 exists, a PERMISSION_DENIED error is returned.

 If the [Product][google.cloud.retail.v2.Product] to update does not exist
 and
 [allow_missing][google.cloud.retail.v2.UpdateProductRequest.allow_missing]
 is not set, a NOT_FOUND error is returned.
 

.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The product.

getProductOrBuilder

ProductOrBuilder getProductOrBuilder()

 Required. The product to update/create.

 If the caller does not have permission to update the
 [Product][google.cloud.retail.v2.Product], regardless of whether or not it
 exists, a PERMISSION_DENIED error is returned.

 If the [Product][google.cloud.retail.v2.Product] to update does not exist
 and
 [allow_missing][google.cloud.retail.v2.UpdateProductRequest.allow_missing]
 is not set, a NOT_FOUND error is returned.
 

.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

hasUpdateMask

boolean hasUpdateMask()

 Indicates which fields in the provided
 [Product][google.cloud.retail.v2.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:

Whether the updateMask field is set.

getUpdateMask

com.google.protobuf.FieldMask getUpdateMask()

 Indicates which fields in the provided
 [Product][google.cloud.retail.v2.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:

The updateMask.

getUpdateMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()

 Indicates which fields in the provided
 [Product][google.cloud.retail.v2.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;

getAllowMissing

boolean getAllowMissing()

 If set to true, and the [Product][google.cloud.retail.v2.Product] is not
 found, a new [Product][google.cloud.retail.v2.Product] will be created. In
 this situation, `update_mask` is ignored.
 

bool allow_missing = 3;

Returns:

The allowMissing.