Package com.google.cloud.retail.v2

Class ListProductsRequest

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListProductsRequest.Builder
      Request message for [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] 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

    • 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

      • getParent

        public String getParent()
         Required. The parent branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use
 `default_branch` as the branch ID, to list products under the default
 branch.

 If the caller does not have permission to list
 [Product][google.cloud.retail.v2.Product]s under this branch, regardless of
 whether or not this branch exists, a PERMISSION_DENIED error is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListProductsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use
 `default_branch` as the branch ID, to list products under the default
 branch.

 If the caller does not have permission to list
 [Product][google.cloud.retail.v2.Product]s under this branch, regardless of
 whether or not this branch exists, a PERMISSION_DENIED error is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListProductsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getPageSize

        public int getPageSize()
         Maximum number of [Product][google.cloud.retail.v2.Product]s to return. If
 unspecified, defaults to 100. The maximum allowed value is 1000. Values
 above 1000 will be coerced to 1000.

 If this field is negative, an INVALID_ARGUMENT error is returned.
        int32 page_size = 2;
        Specified by:
        getPageSize in interface ListProductsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         A page token
 [ListProductsResponse.next_page_token][google.cloud.retail.v2.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 must match the call that provided the page token. Otherwise, an
 INVALID_ARGUMENT error is returned.
        string page_token = 3;
        Specified by:
        getPageToken in interface ListProductsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         A page token
 [ListProductsResponse.next_page_token][google.cloud.retail.v2.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 must match the call that provided the page token. Otherwise, an
 INVALID_ARGUMENT error is returned.
        string page_token = 3;
        Specified by:
        getPageTokenBytes in interface ListProductsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getFilter

        public String getFilter()
         A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2.ListProductsRequest.filter] is unset.
 * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s with a partibular type.
 For example:
     `type = "PRIMARY"`
     `type = "VARIANT"`
     `type = "COLLECTION"`

 If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

 If the specified
 [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error
 is returned.
        string filter = 4;
        Specified by:
        getFilter in interface ListProductsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2.ListProductsRequest.filter] is unset.
 * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s with a partibular type.
 For example:
     `type = "PRIMARY"`
     `type = "VARIANT"`
     `type = "COLLECTION"`

 If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

 If the specified
 [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error
 is returned.
        string filter = 4;
        Specified by:
        getFilterBytes in interface ListProductsRequestOrBuilder
        Returns:
        The bytes for filter.

      • hasReadMask

        public boolean hasReadMask()
         The fields of [Product][google.cloud.retail.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

 * [Product.name][google.cloud.retail.v2.Product.name]
 * [Product.id][google.cloud.retail.v2.Product.id]
 * [Product.title][google.cloud.retail.v2.Product.title]
 * [Product.uri][google.cloud.retail.v2.Product.uri]
 * [Product.images][google.cloud.retail.v2.Product.images]
 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.brands][google.cloud.retail.v2.Product.brands]

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.Product.name] is always returned no
 matter what mask is set.

 If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
 is returned.
        .google.protobuf.FieldMask read_mask = 5;
        Specified by:
        hasReadMask in interface ListProductsRequestOrBuilder
        Returns:
        Whether the readMask field is set.

      • getReadMask

        public com.google.protobuf.FieldMask getReadMask()
         The fields of [Product][google.cloud.retail.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

 * [Product.name][google.cloud.retail.v2.Product.name]
 * [Product.id][google.cloud.retail.v2.Product.id]
 * [Product.title][google.cloud.retail.v2.Product.title]
 * [Product.uri][google.cloud.retail.v2.Product.uri]
 * [Product.images][google.cloud.retail.v2.Product.images]
 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.brands][google.cloud.retail.v2.Product.brands]

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.Product.name] is always returned no
 matter what mask is set.

 If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
 is returned.
        .google.protobuf.FieldMask read_mask = 5;
        Specified by:
        getReadMask in interface ListProductsRequestOrBuilder
        Returns:
        The readMask.

      • getReadMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
         The fields of [Product][google.cloud.retail.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

 * [Product.name][google.cloud.retail.v2.Product.name]
 * [Product.id][google.cloud.retail.v2.Product.id]
 * [Product.title][google.cloud.retail.v2.Product.title]
 * [Product.uri][google.cloud.retail.v2.Product.uri]
 * [Product.images][google.cloud.retail.v2.Product.images]
 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.brands][google.cloud.retail.v2.Product.brands]

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.Product.name] is always returned no
 matter what mask is set.

 If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
 is returned.
        .google.protobuf.FieldMask read_mask = 5;
        Specified by:
        getReadMaskOrBuilder in interface ListProductsRequestOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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