Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::ViewCollectionItemsRequest.
Request message for ViewCollectionItems.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#collection
defcollection()->::String
Returns
(::String) — Required. The collection to view. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
#collection=
defcollection=(value)->::String
Parameter
value (::String) — Required. The collection to view. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
Returns
(::String) — Required. The collection to view. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
#page_size
defpage_size()->::Integer
Returns
(::Integer) — The maximum number of collections to return. The service may return fewer
than this value. If unspecified, at most 50 collections will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — The maximum number of collections to return. The service may return fewer
than this value. If unspecified, at most 50 collections will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
Returns
(::Integer) — The maximum number of collections to return. The service may return fewer
than this value. If unspecified, at most 50 collections will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
#page_token
defpage_token()->::String
Returns
(::String) — A page token, received from a previous ViewCollectionItemsRequest call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ViewCollectionItemsRequest must match the call that provided the page
token.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — A page token, received from a previous ViewCollectionItemsRequest call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ViewCollectionItemsRequest must match the call that provided the page
token.
Returns
(::String) — A page token, received from a previous ViewCollectionItemsRequest call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ViewCollectionItemsRequest must match the call that provided the page
token.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::ViewCollectionItemsRequest (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-ViewCollectionItemsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-ViewCollectionItemsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-ViewCollectionItemsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-ViewCollectionItemsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-ViewCollectionItemsRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-ViewCollectionItemsRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-ViewCollectionItemsRequest) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::ViewCollectionItemsRequest.\n\nRequest message for ViewCollectionItems. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #collection\n\n def collection() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The collection to view. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}`\n\n### #collection=\n\n def collection=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The collection to view. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` \n**Returns**\n\n- (::String) --- Required. The collection to view. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}`\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. \n**Returns**\n\n- (::Integer) --- The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A page token, received from a previous `ViewCollectionItemsRequest` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to\n `ViewCollectionItemsRequest` must match the call that provided the page\n token.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A page token, received from a previous `ViewCollectionItemsRequest` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to\n `ViewCollectionItemsRequest` must match the call that provided the page\ntoken. \n**Returns**\n\n- (::String) --- A page token, received from a previous `ViewCollectionItemsRequest` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to\n `ViewCollectionItemsRequest` must match the call that provided the page\n token."]]