Package com.google.cloud.retail.v2alpha

Class UpdateProductRequest

  • All Implemented Interfaces:
    UpdateProductRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class UpdateProductRequest
extends com.google.protobuf.GeneratedMessageV3
implements UpdateProductRequestOrBuilder
     Request message for
 [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct]
 method.
    Protobuf type google.cloud.retail.v2alpha.UpdateProductRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UpdateProductRequest.Builder
      Request message for [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct] method.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALLOW_MISSING_FIELD_NUMBER  
      static int PRODUCT_FIELD_NUMBER  
      static int UPDATE_MASK_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasProduct

        public boolean hasProduct()
         Required. The product to update/create.

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

 If the [Product][google.cloud.retail.v2alpha.Product] to update does not
 exist and
 [allow_missing][google.cloud.retail.v2alpha.UpdateProductRequest.allow_missing]
 is not set, a NOT_FOUND error is returned.
        .google.cloud.retail.v2alpha.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasProduct in interface UpdateProductRequestOrBuilder
        Returns:
        Whether the product field is set.

      • getProduct

        public Product getProduct()
         Required. The product to update/create.

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

 If the [Product][google.cloud.retail.v2alpha.Product] to update does not
 exist and
 [allow_missing][google.cloud.retail.v2alpha.UpdateProductRequest.allow_missing]
 is not set, a NOT_FOUND error is returned.
        .google.cloud.retail.v2alpha.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getProduct in interface UpdateProductRequestOrBuilder
        Returns:
        The product.

      • getProductOrBuilder

        public ProductOrBuilder getProductOrBuilder()
         Required. The product to update/create.

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

 If the [Product][google.cloud.retail.v2alpha.Product] to update does not
 exist and
 [allow_missing][google.cloud.retail.v2alpha.UpdateProductRequest.allow_missing]
 is not set, a NOT_FOUND error is returned.
        .google.cloud.retail.v2alpha.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getProductOrBuilder in interface UpdateProductRequestOrBuilder

      • hasUpdateMask

        public boolean hasUpdateMask()
         Indicates which fields in the provided
 [Product][google.cloud.retail.v2alpha.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;
        Specified by:
        hasUpdateMask in interface UpdateProductRequestOrBuilder
        Returns:
        Whether the updateMask field is set.

      • getUpdateMask

        public com.google.protobuf.FieldMask getUpdateMask()
         Indicates which fields in the provided
 [Product][google.cloud.retail.v2alpha.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;
        Specified by:
        getUpdateMask in interface UpdateProductRequestOrBuilder
        Returns:
        The updateMask.

      • getUpdateMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
         Indicates which fields in the provided
 [Product][google.cloud.retail.v2alpha.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;
        Specified by:
        getUpdateMaskOrBuilder in interface UpdateProductRequestOrBuilder

      • getAllowMissing

        public boolean getAllowMissing()
         If set to true, and the [Product][google.cloud.retail.v2alpha.Product] is
 not found, a new [Product][google.cloud.retail.v2alpha.Product] will be
 created. In this situation, `update_mask` is ignored.
        bool allow_missing = 3;
        Specified by:
        getAllowMissing in interface UpdateProductRequestOrBuilder
        Returns:
        The allowMissing.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static UpdateProductRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateProductRequest parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateProductRequest parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateProductRequest parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateProductRequest parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateProductRequest parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public UpdateProductRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public UpdateProductRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected UpdateProductRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<UpdateProductRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public UpdateProductRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder