Package com.google.cloud.retail.v2alpha

Class PurgeProductsRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PurgeProductsRequest.Builder
    Request message for PurgeProducts 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
    FILTER_FIELD_NUMBER
     
    static final int
    FORCE_FIELD_NUMBER
     
    static final int
    PARENT_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)
     
    static PurgeProductsRequest
    getDefaultInstance()
     
    PurgeProductsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFilter()
    Required.
    com.google.protobuf.ByteString
    getFilterBytes()
    Required.
    boolean
    getForce()
    Actually perform the purge.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<PurgeProductsRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PurgeProductsRequest.Builder
    newBuilder()
     
    static PurgeProductsRequest.Builder
    newBuilder(PurgeProductsRequest prototype)
     
    PurgeProductsRequest.Builder
    newBuilderForType()
     
    protected PurgeProductsRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PurgeProductsRequest
    parseDelimitedFrom(InputStream input)
     
    static PurgeProductsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeProductsRequest
    parseFrom(byte[] data)
     
    static PurgeProductsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeProductsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static PurgeProductsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeProductsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PurgeProductsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeProductsRequest
    parseFrom(InputStream input)
     
    static PurgeProductsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeProductsRequest
    parseFrom(ByteBuffer data)
     
    static PurgeProductsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PurgeProductsRequest>
    parser()
     
    PurgeProductsRequest.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

  • 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

    • getParent

      public String getParent()
       Required. The resource name of the branch under which the products are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface PurgeProductsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the branch under which the products are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface PurgeProductsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getFilter

      public String getFilter()
       Required. The filter string to specify the products to be deleted with a
 length limit of 5,000 characters.

 Empty string filter is not allowed. "*" implies delete all items in a
 branch.

 The eligible fields for filtering are:

 * `availability`: Double quoted
 [Product.availability][google.cloud.retail.v2alpha.Product.availability]
 string.
 * `create_time` : in ISO 8601 "zulu" format.

 Supported syntax:

 * Comparators (">", "<", ">=", "<=", "=").
 Examples:
 * create_time <= "2015-02-13T17:05:46Z"
 * availability = "IN_STOCK"

 * Conjunctions ("AND")
 Examples:
 * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

 * Disjunctions ("OR")
 Examples:
 * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

 * Can support nested queries.
 Examples:
 * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
 OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

 * Filter Limits:
 * Filter should not contain more than 6 conditions.
 * Max nesting depth should not exceed 2 levels.

 Examples queries:
 * Delete back order products created before a timestamp.
 create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFilter in interface PurgeProductsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Required. The filter string to specify the products to be deleted with a
 length limit of 5,000 characters.

 Empty string filter is not allowed. "*" implies delete all items in a
 branch.

 The eligible fields for filtering are:

 * `availability`: Double quoted
 [Product.availability][google.cloud.retail.v2alpha.Product.availability]
 string.
 * `create_time` : in ISO 8601 "zulu" format.

 Supported syntax:

 * Comparators (">", "<", ">=", "<=", "=").
 Examples:
 * create_time <= "2015-02-13T17:05:46Z"
 * availability = "IN_STOCK"

 * Conjunctions ("AND")
 Examples:
 * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

 * Disjunctions ("OR")
 Examples:
 * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

 * Can support nested queries.
 Examples:
 * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
 OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

 * Filter Limits:
 * Filter should not contain more than 6 conditions.
 * Max nesting depth should not exceed 2 levels.

 Examples queries:
 * Delete back order products created before a timestamp.
 create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFilterBytes in interface PurgeProductsRequestOrBuilder
      Returns:
      The bytes for filter.

    • getForce

      public boolean getForce()
       Actually perform the purge.
 If `force` is set to false, the method will return the expected purge count
 without deleting any products.
      bool force = 3;
      Specified by:
      getForce in interface PurgeProductsRequestOrBuilder
      Returns:
      The force.

    • 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 PurgeProductsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PurgeProductsRequest.Builder newBuilder()

    • newBuilder

      public static PurgeProductsRequest.Builder newBuilder(PurgeProductsRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected PurgeProductsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PurgeProductsRequest getDefaultInstance()

    • parser

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

    • getParserForType

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