Generated from protobuf message google.cloud.apihub.v1.ListVersionsRequest
Namespace
Google \ Cloud \ ApiHub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent which owns this collection of API versions i.e., the API resource Format: projects/{project}/locations/{location}/apis/{api}
↳ filter
string
Optional. An expression that filters the list of Versions. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the Version are eligible for filtering: * * display_name - The display name of the Version. Allowed comparison operators: =. * * create_time - The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * * lifecycle.enum_values.values.id - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: :. * * lifecycle.enum_values.values.display_name - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: :. * * compliance.enum_values.values.id - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: :. * * compliance.enum_values.values.display_name - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: :. * * accreditation.enum_values.values.id - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: :. * * accreditation.enum_values.values.display_name - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: :. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * * lifecycle.enum_values.values.id: preview-id - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id. * * lifecycle.enum_values.values.display_name: \"Preview Display Name\" - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is Preview Display Name. * * lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * * compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id - The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id.
↳ page_size
int
Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
↳ page_token
string
Optional. A page token, received from a previous ListVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListVersions must match the call that provided the page token.
getParent
Required. The parent which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
Returns
Type
Description
string
setParent
Required. The parent which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. An expression that filters the list of Versions.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string, a
number, or a boolean. The comparison operator must be one of: <, > or
=. Filters are not case sensitive.
The following fields in the Version are eligible for filtering:
display_name - The display name of the Version. Allowed
comparison operators: =.
create_time - The time at which the Version was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
lifecycle.enum_values.values.id - The allowed value id of the
lifecycle attribute associated with the Version. Allowed comparison
operators: :.
lifecycle.enum_values.values.display_name - The allowed value display
name of the lifecycle attribute associated with the Version. Allowed
comparison operators: :.
compliance.enum_values.values.id - The allowed value id of the
compliances attribute associated with the Version. Allowed comparison
operators: :.
compliance.enum_values.values.display_name - The allowed value
display name of the compliances attribute associated with the Version.
Allowed comparison operators: :.
accreditation.enum_values.values.id - The allowed value id of the
accreditations attribute associated with the Version. Allowed
comparison operators: :.
accreditation.enum_values.values.display_name - The allowed value
display name of the accreditations attribute associated with the Version.
Allowed comparison operators: :.
Expressions are combined with either AND logic operator or OR logical
operator but not both of them together i.e. only one of the AND or OR
operator can be used throughout the filter string and both the operators
cannot be used together. No other logical operators are
supported. At most three filter fields are allowed in the filter
string and if provided more than that then INVALID_ARGUMENT error is
returned by the API.
Here are a few examples:
lifecycle.enum_values.values.id: preview-id - The filter string
specifies that the id of the allowed value associated with the lifecycle
attribute of the Version is preview-id.
lifecycle.enum_values.values.display_name: \"Preview Display Name\" -
The filter string specifies that the display name of the allowed value
associated with the lifecycle attribute of the Version is Preview
Display Name.
lifecycle.enum_values.values.id: preview-id AND create_time <
\"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" -
The id of the allowed value associated with the lifecycle attribute of
the Version is preview-id and it was created before 2021-08-15
14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
compliance.enum_values.values.id: gdpr-id OR
compliance.enum_values.values.id: pci-dss-id
The id of the allowed value associated with the compliance attribute is
gdpr-id or pci-dss-id.
Returns
Type
Description
string
setFilter
Optional. An expression that filters the list of Versions.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string, a
number, or a boolean. The comparison operator must be one of: <, > or
=. Filters are not case sensitive.
The following fields in the Version are eligible for filtering:
display_name - The display name of the Version. Allowed
comparison operators: =.
create_time - The time at which the Version was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
lifecycle.enum_values.values.id - The allowed value id of the
lifecycle attribute associated with the Version. Allowed comparison
operators: :.
lifecycle.enum_values.values.display_name - The allowed value display
name of the lifecycle attribute associated with the Version. Allowed
comparison operators: :.
compliance.enum_values.values.id - The allowed value id of the
compliances attribute associated with the Version. Allowed comparison
operators: :.
compliance.enum_values.values.display_name - The allowed value
display name of the compliances attribute associated with the Version.
Allowed comparison operators: :.
accreditation.enum_values.values.id - The allowed value id of the
accreditations attribute associated with the Version. Allowed
comparison operators: :.
accreditation.enum_values.values.display_name - The allowed value
display name of the accreditations attribute associated with the Version.
Allowed comparison operators: :.
Expressions are combined with either AND logic operator or OR logical
operator but not both of them together i.e. only one of the AND or OR
operator can be used throughout the filter string and both the operators
cannot be used together. No other logical operators are
supported. At most three filter fields are allowed in the filter
string and if provided more than that then INVALID_ARGUMENT error is
returned by the API.
Here are a few examples:
lifecycle.enum_values.values.id: preview-id - The filter string
specifies that the id of the allowed value associated with the lifecycle
attribute of the Version is preview-id.
lifecycle.enum_values.values.display_name: \"Preview Display Name\" -
The filter string specifies that the display name of the allowed value
associated with the lifecycle attribute of the Version is Preview
Display Name.
lifecycle.enum_values.values.id: preview-id AND create_time <
\"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" -
The id of the allowed value associated with the lifecycle attribute of
the Version is preview-id and it was created before 2021-08-15
14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
compliance.enum_values.values.id: gdpr-id OR
compliance.enum_values.values.id: pci-dss-id
The id of the allowed value associated with the compliance attribute is
gdpr-id or pci-dss-id.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of versions to return. The service may return
fewer than this value. If unspecified, at most 50 versions will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of versions to return. The service may return
fewer than this value. If unspecified, at most 50 versions will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token, received from a previous ListVersions call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListVersions must match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previous ListVersions call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListVersions must match the call that provided the page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
Please see ApiHubClient::apiName() for help formatting this field.
[[["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-08-28 UTC."],[],[],null,["# Google Cloud Api Hub V1 Client - Class ListVersionsRequest (0.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.2.1 (latest)](/php/docs/reference/cloud-apihub/latest/V1.ListVersionsRequest)\n- [0.2.0](/php/docs/reference/cloud-apihub/0.2.0/V1.ListVersionsRequest)\n- [0.1.4](/php/docs/reference/cloud-apihub/0.1.4/V1.ListVersionsRequest) \nReference documentation and code samples for the Google Cloud Api Hub V1 Client class ListVersionsRequest.\n\nThe [ListVersions](/php/docs/reference/cloud-apihub/latest/V1.Client.ApiHubClient#_Google_Cloud_ApiHub_V1_Client_ApiHubClient__listVersions__) method's\nrequest.\n\nGenerated from protobuf message `google.cloud.apihub.v1.ListVersionsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ApiHub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent which owns this collection of API versions i.e., the\nAPI resource Format: `projects/{project}/locations/{location}/apis/{api}`\n\n### setParent\n\nRequired. The parent which owns this collection of API versions i.e., the\nAPI resource Format: `projects/{project}/locations/{location}/apis/{api}`\n\n### getFilter\n\nOptional. An expression that filters the list of Versions.\n\nA filter expression consists of a field name, a comparison\noperator, and a value for filtering. The value must be a string, a\nnumber, or a boolean. The comparison operator must be one of: `\u003c`, `\u003e` or\n`=`. Filters are not case sensitive.\nThe following fields in the `Version` are eligible for filtering:\n\n- `display_name` - The display name of the Version. Allowed comparison operators: `=`.\n- `create_time` - The time at which the Version was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`.\n- `lifecycle.enum_values.values.id` - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`.\n- `lifecycle.enum_values.values.display_name` - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`.\n- `compliance.enum_values.values.id` - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: `:`.\n- `compliance.enum_values.values.display_name` - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: `:`.\n- `accreditation.enum_values.values.id` - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: `:`.\n- `accreditation.enum_values.values.display_name` - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples:\n- `lifecycle.enum_values.values.id: preview-id` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is *preview-id*.\n- `lifecycle.enum_values.values.display_name: \\\"Preview Display Name\\\"` - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is `Preview\n Display Name`.\n- `lifecycle.enum_values.values.id: preview-id AND create_time \u003c\n \\\"2021-08-15T14:50:00Z\\\" AND create_time \u003e \\\"2021-08-10T12:00:00Z\\\"` - The id of the allowed value associated with the lifecycle attribute of the Version is *preview-id* and it was created before *2021-08-15\n 14:50:00 UTC* and after *2021-08-10 12:00:00 UTC*.\n- `compliance.enum_values.values.id: gdpr-id OR\n compliance.enum_values.values.id: pci-dss-id`\n- The id of the allowed value associated with the compliance attribute is *gdpr-id* or *pci-dss-id*.\n\n### setFilter\n\nOptional. An expression that filters the list of Versions.\n\nA filter expression consists of a field name, a comparison\noperator, and a value for filtering. The value must be a string, a\nnumber, or a boolean. The comparison operator must be one of: `\u003c`, `\u003e` or\n`=`. Filters are not case sensitive.\nThe following fields in the `Version` are eligible for filtering:\n\n- `display_name` - The display name of the Version. Allowed comparison operators: `=`.\n- `create_time` - The time at which the Version was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`.\n- `lifecycle.enum_values.values.id` - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`.\n- `lifecycle.enum_values.values.display_name` - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`.\n- `compliance.enum_values.values.id` - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: `:`.\n- `compliance.enum_values.values.display_name` - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: `:`.\n- `accreditation.enum_values.values.id` - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: `:`.\n- `accreditation.enum_values.values.display_name` - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples:\n- `lifecycle.enum_values.values.id: preview-id` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is *preview-id*.\n- `lifecycle.enum_values.values.display_name: \\\"Preview Display Name\\\"` - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is `Preview\n Display Name`.\n- `lifecycle.enum_values.values.id: preview-id AND create_time \u003c\n \\\"2021-08-15T14:50:00Z\\\" AND create_time \u003e \\\"2021-08-10T12:00:00Z\\\"` - The id of the allowed value associated with the lifecycle attribute of the Version is *preview-id* and it was created before *2021-08-15\n 14:50:00 UTC* and after *2021-08-10 12:00:00 UTC*.\n- `compliance.enum_values.values.id: gdpr-id OR\n compliance.enum_values.values.id: pci-dss-id`\n- The id of the allowed value associated with the compliance attribute is *gdpr-id* or *pci-dss-id*.\n\n### getPageSize\n\nOptional. The maximum number of versions to return. The service may return\nfewer than this value. If unspecified, at most 50 versions will be\nreturned. The maximum value is 1000; values above 1000 will be coerced to\n1000.\n\n### setPageSize\n\nOptional. The maximum number of versions to return. The service may return\nfewer than this value. If unspecified, at most 50 versions will be\nreturned. The maximum value is 1000; values above 1000 will be coerced to\n1000.\n\n### getPageToken\n\nOptional. A page token, received from a previous `ListVersions` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters (except page_size) provided to\n`ListVersions` must match the call that provided the page token.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListVersions` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters (except page_size) provided to\n`ListVersions` must match the call that provided the page token.\n\n### static::build"]]
