public final class ListProductsRequest extends com.google.protobuf.GeneratedMessageV3 implements ListProductsRequestOrBuilder
Request message for [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] method.Protobuf type
google.cloud.retail.v2alpha.ListProductsRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ListProductsRequest.Builder
Request message for
[ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
method.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
FILTER_FIELD_NUMBER |
static int |
PAGE_SIZE_FIELD_NUMBER |
static int |
PAGE_TOKEN_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
READ_MASK_FIELD_NUMBER |
static int |
REQUIRE_TOTAL_SIZE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static ListProductsRequest |
getDefaultInstance() |
ListProductsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getFilter()
A filter to apply on the list results.
|
com.google.protobuf.ByteString |
getFilterBytes()
A filter to apply on the list results.
|
int |
getPageSize()
Maximum number of [Product][google.cloud.retail.v2alpha.Product]s to
return.
|
String |
getPageToken()
A page token
[ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token],
received from a previous
[ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
call.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
A page token
[ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token],
received from a previous
[ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
call.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
com.google.protobuf.Parser<ListProductsRequest> |
getParserForType() |
com.google.protobuf.FieldMask |
getReadMask()
The fields of [Product][google.cloud.retail.v2alpha.Product] to return in
the responses.
|
com.google.protobuf.FieldMaskOrBuilder |
getReadMaskOrBuilder()
The fields of [Product][google.cloud.retail.v2alpha.Product] to return in
the responses.
|
boolean |
getRequireTotalSize()
If true and
[page_token][google.cloud.retail.v2alpha.ListProductsRequest.page_token] is
empty,
[ListProductsResponse.total_size][google.cloud.retail.v2alpha.ListProductsResponse.total_size]
is set to the total count of matched items irrespective of pagination.
|
int |
getSerializedSize() |
int |
hashCode() |
boolean |
hasReadMask()
The fields of [Product][google.cloud.retail.v2alpha.Product] to return in
the responses.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ListProductsRequest.Builder |
newBuilder() |
static ListProductsRequest.Builder |
newBuilder(ListProductsRequest prototype) |
ListProductsRequest.Builder |
newBuilderForType() |
protected ListProductsRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ListProductsRequest |
parseDelimitedFrom(InputStream input) |
static ListProductsRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListProductsRequest |
parseFrom(byte[] data) |
static ListProductsRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListProductsRequest |
parseFrom(ByteBuffer data) |
static ListProductsRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListProductsRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ListProductsRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListProductsRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ListProductsRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListProductsRequest |
parseFrom(InputStream input) |
static ListProductsRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ListProductsRequest> |
parser() |
ListProductsRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int PARENT_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
public static final int REQUIRE_TOTAL_SIZE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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.v2alpha.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) = { ... }
getParent in interface ListProductsRequestOrBuilderpublic 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.v2alpha.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) = { ... }
getParentBytes in interface ListProductsRequestOrBuilderpublic int getPageSize()
Maximum number of [Product][google.cloud.retail.v2alpha.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;getPageSize in interface ListProductsRequestOrBuilderpublic String getPageToken()
A page token [ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
string page_token = 3;getPageToken in interface ListProductsRequestOrBuilderpublic com.google.protobuf.ByteString getPageTokenBytes()
A page token [ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
string page_token = 3;getPageTokenBytes in interface ListProductsRequestOrBuilderpublic 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.v2alpha.ListProductsRequest.filter] is unset.
* List
[Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
[Product][google.cloud.retail.v2alpha.Product]s sharing the same
[Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
[Product][google.cloud.retail.v2alpha.Product]. For example:
`primary_product_id = "some_product_id"`
* List [Product][google.cloud.retail.v2alpha.Product]s bundled in a
[Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
[Product][google.cloud.retail.v2alpha.Product].
For example:
`collection_product_id = "some_product_id"`
* List [Product][google.cloud.retail.v2alpha.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.v2alpha.Product.Type.PRIMARY]
[Product][google.cloud.retail.v2alpha.Product] or
[Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
[Product][google.cloud.retail.v2alpha.Product] does not exist, a NOT_FOUND
error is returned.
string filter = 4;getFilter in interface ListProductsRequestOrBuilderpublic 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.v2alpha.ListProductsRequest.filter] is unset.
* List
[Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
[Product][google.cloud.retail.v2alpha.Product]s sharing the same
[Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
[Product][google.cloud.retail.v2alpha.Product]. For example:
`primary_product_id = "some_product_id"`
* List [Product][google.cloud.retail.v2alpha.Product]s bundled in a
[Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
[Product][google.cloud.retail.v2alpha.Product].
For example:
`collection_product_id = "some_product_id"`
* List [Product][google.cloud.retail.v2alpha.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.v2alpha.Product.Type.PRIMARY]
[Product][google.cloud.retail.v2alpha.Product] or
[Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
[Product][google.cloud.retail.v2alpha.Product] does not exist, a NOT_FOUND
error is returned.
string filter = 4;getFilterBytes in interface ListProductsRequestOrBuilderpublic boolean hasReadMask()
The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses. If not set or empty, the following fields are returned: * [Product.name][google.cloud.retail.v2alpha.Product.name] * [Product.id][google.cloud.retail.v2alpha.Product.id] * [Product.title][google.cloud.retail.v2alpha.Product.title] * [Product.uri][google.cloud.retail.v2alpha.Product.uri] * [Product.images][google.cloud.retail.v2alpha.Product.images] * [Product.price_info][google.cloud.retail.v2alpha.Product.price_info] * [Product.brands][google.cloud.retail.v2alpha.Product.brands] If "*" is provided, all fields are returned. [Product.name][google.cloud.retail.v2alpha.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;hasReadMask in interface ListProductsRequestOrBuilderpublic com.google.protobuf.FieldMask getReadMask()
The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses. If not set or empty, the following fields are returned: * [Product.name][google.cloud.retail.v2alpha.Product.name] * [Product.id][google.cloud.retail.v2alpha.Product.id] * [Product.title][google.cloud.retail.v2alpha.Product.title] * [Product.uri][google.cloud.retail.v2alpha.Product.uri] * [Product.images][google.cloud.retail.v2alpha.Product.images] * [Product.price_info][google.cloud.retail.v2alpha.Product.price_info] * [Product.brands][google.cloud.retail.v2alpha.Product.brands] If "*" is provided, all fields are returned. [Product.name][google.cloud.retail.v2alpha.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;getReadMask in interface ListProductsRequestOrBuilderpublic com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses. If not set or empty, the following fields are returned: * [Product.name][google.cloud.retail.v2alpha.Product.name] * [Product.id][google.cloud.retail.v2alpha.Product.id] * [Product.title][google.cloud.retail.v2alpha.Product.title] * [Product.uri][google.cloud.retail.v2alpha.Product.uri] * [Product.images][google.cloud.retail.v2alpha.Product.images] * [Product.price_info][google.cloud.retail.v2alpha.Product.price_info] * [Product.brands][google.cloud.retail.v2alpha.Product.brands] If "*" is provided, all fields are returned. [Product.name][google.cloud.retail.v2alpha.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;getReadMaskOrBuilder in interface ListProductsRequestOrBuilderpublic boolean getRequireTotalSize()
If true and [page_token][google.cloud.retail.v2alpha.ListProductsRequest.page_token] is empty, [ListProductsResponse.total_size][google.cloud.retail.v2alpha.ListProductsResponse.total_size] is set to the total count of matched items irrespective of pagination. Notice that setting this field to true affects the performance.
bool require_total_size = 6;getRequireTotalSize in interface ListProductsRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ListProductsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListProductsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListProductsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListProductsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListProductsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListProductsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListProductsRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ListProductsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListProductsRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ListProductsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListProductsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ListProductsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ListProductsRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ListProductsRequest.Builder newBuilder()
public static ListProductsRequest.Builder newBuilder(ListProductsRequest prototype)
public ListProductsRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ListProductsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ListProductsRequest getDefaultInstance()
public static com.google.protobuf.Parser<ListProductsRequest> parser()
public com.google.protobuf.Parser<ListProductsRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ListProductsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.