Package com.google.cloud.retail.v2alpha
Class ListProductsRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.ListProductsRequest
- All Implemented Interfaces:
ListProductsRequestOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class ListProductsRequest
extends com.google.protobuf.GeneratedMessage
implements ListProductsRequestOrBuilder
Request message for [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] method.Protobuf type
google.cloud.retail.v2alpha.ListProductsRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRequest message for [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] 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.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic ListProductsRequeststatic final com.google.protobuf.Descriptors.DescriptorA filter to apply on the list results.com.google.protobuf.ByteStringA filter to apply on the list results.intMaximum number of [Product][google.cloud.retail.v2alpha.Product]s to return.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.ByteStringA 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.Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.Parser<ListProductsRequest>com.google.protobuf.FieldMaskThe fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.com.google.protobuf.FieldMaskOrBuilderThe fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.booleanIf 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.intinthashCode()booleanThe fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic ListProductsRequest.Builderstatic ListProductsRequest.BuildernewBuilder(ListProductsRequest prototype) protected ListProductsRequest.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ListProductsRequestparseDelimitedFrom(InputStream input) static ListProductsRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListProductsRequestparseFrom(byte[] data) static ListProductsRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListProductsRequestparseFrom(com.google.protobuf.ByteString data) static ListProductsRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListProductsRequestparseFrom(com.google.protobuf.CodedInputStream input) static ListProductsRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListProductsRequestparseFrom(InputStream input) static ListProductsRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListProductsRequestparseFrom(ByteBuffer data) static ListProductsRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ListProductsRequest>parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER- See Also:
-
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER- See Also:
-
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER- See Also:
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER- See Also:
-
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER- See Also:
-
REQUIRE_TOTAL_SIZE_FIELD_NUMBER
public static final int REQUIRE_TOTAL_SIZE_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:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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) = { ... }- Specified by:
getParentin interfaceListProductsRequestOrBuilder- 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.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) = { ... }- Specified by:
getParentBytesin interfaceListProductsRequestOrBuilder- Returns:
- The bytes for parent.
-
getPageSize
public 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;- Specified by:
getPageSizein interfaceListProductsRequestOrBuilder- Returns:
- The pageSize.
-
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;- Specified by:
getPageTokenin interfaceListProductsRequestOrBuilder- Returns:
- The pageToken.
-
getPageTokenBytes
public 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;- Specified by:
getPageTokenBytesin interfaceListProductsRequestOrBuilder- Returns:
- The bytes for pageToken.
-
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;- Specified by:
getFilterin interfaceListProductsRequestOrBuilder- 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.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;- Specified by:
getFilterBytesin interfaceListProductsRequestOrBuilder- Returns:
- The bytes for filter.
-
hasReadMask
public 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;- Specified by:
hasReadMaskin interfaceListProductsRequestOrBuilder- Returns:
- Whether the readMask field is set.
-
getReadMask
public 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;- Specified by:
getReadMaskin interfaceListProductsRequestOrBuilder- Returns:
- The readMask.
-
getReadMaskOrBuilder
public 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;- Specified by:
getReadMaskOrBuilderin interfaceListProductsRequestOrBuilder
-
getRequireTotalSize
public 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;- Specified by:
getRequireTotalSizein interfaceListProductsRequestOrBuilder- Returns:
- The requireTotalSize.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static ListProductsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ListProductsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ListProductsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ListProductsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ListProductsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-