Class DeleteProductRequest

  • All Implemented Interfaces:
    DeleteProductRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class DeleteProductRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements DeleteProductRequestOrBuilder
     Request message for
     [ProductService.DeleteProduct][google.cloud.retail.v2alpha.ProductService.DeleteProduct]
     method.
     
    Protobuf type google.cloud.retail.v2alpha.DeleteProductRequest
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DeleteProductRequest.Builder
      Request message for [ProductService.DeleteProduct][google.cloud.retail.v2alpha.ProductService.DeleteProduct] 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 FORCE_FIELD_NUMBER  
      static int NAME_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
      • getName

        public String getName()
         Required. Full resource name of
         [Product][google.cloud.retail.v2alpha.Product], such as
         `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
        
         If the caller does not have permission to delete 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 delete does not
         exist, a NOT_FOUND error is returned.
        
         The [Product][google.cloud.retail.v2alpha.Product] to delete can neither be
         a
         [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
         [Product][google.cloud.retail.v2alpha.Product] member nor a
         [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
         [Product][google.cloud.retail.v2alpha.Product] with more than one
         [variants][google.cloud.retail.v2alpha.Product.Type.VARIANT]. Otherwise, an
         INVALID_ARGUMENT error is returned.
        
         All inventory information for the named
         [Product][google.cloud.retail.v2alpha.Product] will be deleted.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface DeleteProductRequestOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. Full resource name of
         [Product][google.cloud.retail.v2alpha.Product], such as
         `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
        
         If the caller does not have permission to delete 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 delete does not
         exist, a NOT_FOUND error is returned.
        
         The [Product][google.cloud.retail.v2alpha.Product] to delete can neither be
         a
         [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
         [Product][google.cloud.retail.v2alpha.Product] member nor a
         [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
         [Product][google.cloud.retail.v2alpha.Product] with more than one
         [variants][google.cloud.retail.v2alpha.Product.Type.VARIANT]. Otherwise, an
         INVALID_ARGUMENT error is returned.
        
         All inventory information for the named
         [Product][google.cloud.retail.v2alpha.Product] will be deleted.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface DeleteProductRequestOrBuilder
        Returns:
        The bytes for name.
      • getForce

        public boolean getForce()
         This value only applies to the case when the target product is of type
         PRIMARY.
         When deleting a product of VARIANT/COLLECTION type, this value
         will be ignored.
         When set to true, the subsequent variant products will be
         deleted.
         When set to false, if the primary product has active variant products, an
         error will be returned.
         
        bool force = 4;
        Specified by:
        getForce in interface DeleteProductRequestOrBuilder
        Returns:
        The force.
      • 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 DeleteProductRequest parseFrom​(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<DeleteProductRequest> 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 DeleteProductRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder