Package com.google.cloud.retail.v2alpha

Class UpdateProductRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.UpdateProductRequest
All Implemented Interfaces:
UpdateProductRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class UpdateProductRequest extends com.google.protobuf.GeneratedMessage implements UpdateProductRequestOrBuilder
 Request message for
 [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct]
 method.
Protobuf type google.cloud.retail.v2alpha.UpdateProductRequest
See Also:

  • Nested Class Summary

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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

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

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static UpdateProductRequest
    getDefaultInstance()
     
    UpdateProductRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<UpdateProductRequest>
    getParserForType()
     
    Product
    getProduct()
    Required.
    ProductOrBuilder
    getProductOrBuilder()
    Required.
    int
    getSerializedSize()
     
    com.google.protobuf.FieldMask
    getUpdateMask()
    Indicates which fields in the provided [Product][google.cloud.retail.v2alpha.Product] to update.
    com.google.protobuf.FieldMaskOrBuilder
    getUpdateMaskOrBuilder()
    Indicates which fields in the provided [Product][google.cloud.retail.v2alpha.Product] to update.
    int
    hashCode()
     
    boolean
    hasProduct()
    Required.
    boolean
    hasUpdateMask()
    Indicates which fields in the provided [Product][google.cloud.retail.v2alpha.Product] to update.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static UpdateProductRequest.Builder
    newBuilder()
     
    static UpdateProductRequest.Builder
    newBuilder(UpdateProductRequest prototype)
     
    UpdateProductRequest.Builder
    newBuilderForType()
     
    protected UpdateProductRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static UpdateProductRequest
    parseDelimitedFrom(InputStream input)
     
    static UpdateProductRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpdateProductRequest
    parseFrom(byte[] data)
     
    static UpdateProductRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpdateProductRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static UpdateProductRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpdateProductRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static UpdateProductRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpdateProductRequest
    parseFrom(InputStream input)
     
    static UpdateProductRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpdateProductRequest
    parseFrom(ByteBuffer data)
     
    static UpdateProductRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<UpdateProductRequest>
    parser()
     
    UpdateProductRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PRODUCT_FIELD_NUMBER

      public static final int PRODUCT_FIELD_NUMBER
      See Also:

    • UPDATE_MASK_FIELD_NUMBER

      public static final int UPDATE_MASK_FIELD_NUMBER
      See Also:

    • ALLOW_MISSING_FIELD_NUMBER

      public static final int ALLOW_MISSING_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static UpdateProductRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateProductRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateProductRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateProductRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateProductRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateProductRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static UpdateProductRequest.Builder newBuilder()

    • newBuilder

      public static UpdateProductRequest.Builder newBuilder(UpdateProductRequest prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static UpdateProductRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UpdateProductRequest> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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