Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ListSpecsRequest.
The ListSpecs method's request.
Generated from protobuf message google.cloud.apihub.v1.ListSpecsRequest
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 specs. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}
↳ filter
string
Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, >, : or =. Filters are not case sensitive. The following fields in the Spec are eligible for filtering: * * display_name - The display name of the Spec. Allowed comparison operators: =. * * create_time - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * * spec_type.enum_values.values.id - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: :. * * spec_type.enum_values.values.display_name - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: :. * * lint_response.json_values.values - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: :. * * mime_type - The MIME type of the Spec. 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: * * spec_type.enum_values.values.id: rest-id - The filter string specifies that the id of the allowed value associated with the spec_type attribute is rest-id. * * spec_type.enum_values.values.display_name: \"Rest Display Name\" - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is Rest Display Name. * * spec_type.enum_values.values.id: grpc-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 spec_type attribute is grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * * spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id - The id of the allowed value associated with the spec_type attribute is rest-id or grpc-id.
↳ page_size
int
Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs 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 ListSpecs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSpecs must match the call that provided the page token.
getParent
Required. The parent, which owns this collection of specs.
Optional. An expression that filters the list of Specs.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <, >, : or =. Filters are not
case sensitive.
The following fields in the Spec are eligible for filtering:
display_name - The display name of the Spec. Allowed comparison
operators: =.
create_time - The time at which the Spec was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
spec_type.enum_values.values.id - The allowed value id of the
spec_type attribute associated with the Spec. Allowed comparison
operators: :.
spec_type.enum_values.values.display_name - The allowed value display
name of the spec_type attribute associated with the Spec. Allowed
comparison operators: :.
lint_response.json_values.values - The json value of the
lint_response attribute associated with the Spec. Allowed comparison
operators: :.
mime_type - The MIME type of the Spec. 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:
spec_type.enum_values.values.id: rest-id - The filter
string specifies that the id of the allowed value associated with the
spec_type attribute is rest-id.
spec_type.enum_values.values.display_name: \"Rest Display Name\" -
The filter string specifies that the display name of the allowed value
associated with the spec_type attribute is Rest Display Name.
spec_type.enum_values.values.id: grpc-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 spec_type attribute is
grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and
after 2021-08-10 12:00:00 UTC.
spec_type.enum_values.values.id: rest-id OR
spec_type.enum_values.values.id: grpc-id
The id of the allowed value associated with the spec_type attribute is
rest-id or grpc-id.
Returns
Type
Description
string
setFilter
Optional. An expression that filters the list of Specs.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <, >, : or =. Filters are not
case sensitive.
The following fields in the Spec are eligible for filtering:
display_name - The display name of the Spec. Allowed comparison
operators: =.
create_time - The time at which the Spec was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
spec_type.enum_values.values.id - The allowed value id of the
spec_type attribute associated with the Spec. Allowed comparison
operators: :.
spec_type.enum_values.values.display_name - The allowed value display
name of the spec_type attribute associated with the Spec. Allowed
comparison operators: :.
lint_response.json_values.values - The json value of the
lint_response attribute associated with the Spec. Allowed comparison
operators: :.
mime_type - The MIME type of the Spec. 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:
spec_type.enum_values.values.id: rest-id - The filter
string specifies that the id of the allowed value associated with the
spec_type attribute is rest-id.
spec_type.enum_values.values.display_name: \"Rest Display Name\" -
The filter string specifies that the display name of the allowed value
associated with the spec_type attribute is Rest Display Name.
spec_type.enum_values.values.id: grpc-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 spec_type attribute is
grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and
after 2021-08-10 12:00:00 UTC.
spec_type.enum_values.values.id: rest-id OR
spec_type.enum_values.values.id: grpc-id
The id of the allowed value associated with the spec_type attribute is
rest-id or grpc-id.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of specs to return. The service may return
fewer than this value. If unspecified, at most 50 specs 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 specs to return. The service may return
fewer than this value. If unspecified, at most 50 specs 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 ListSpecs call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListSpecs must
match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previous ListSpecs call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListSpecs 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 specs.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
Please see ApiHubClient::versionName() 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-09-09 UTC."],[],[],null,["# Google Cloud Api Hub V1 Client - Class ListSpecsRequest (0.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.2.1 (latest)](/php/docs/reference/cloud-apihub/latest/V1.ListSpecsRequest)\n- [0.2.0](/php/docs/reference/cloud-apihub/0.2.0/V1.ListSpecsRequest)\n- [0.1.4](/php/docs/reference/cloud-apihub/0.1.4/V1.ListSpecsRequest) \nReference documentation and code samples for the Google Cloud Api Hub V1 Client class ListSpecsRequest.\n\nThe ListSpecs method's request.\n\nGenerated from protobuf message `google.cloud.apihub.v1.ListSpecsRequest`\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 specs.\n\nFormat:\n`projects/{project}/locations/{location}/apis/{api}/versions/{version}`\n\n### setParent\n\nRequired. The parent, which owns this collection of specs.\n\nFormat:\n`projects/{project}/locations/{location}/apis/{api}/versions/{version}`\n\n### getFilter\n\nOptional. An expression that filters the list of Specs.\n\nA filter expression consists of a field name, a comparison\noperator, and a value for filtering. The value must be a string. The\ncomparison operator must be one of: `\u003c`, `\u003e`, `:` or `=`. Filters are not\ncase sensitive.\nThe following fields in the `Spec` are eligible for filtering:\n\n- `display_name` - The display name of the Spec. Allowed comparison operators: `=`.\n- `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`.\n- `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`.\n- `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`.\n- `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`.\n- `mime_type` - The MIME type of the Spec. 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- `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is *rest-id*.\n- `spec_type.enum_values.values.display_name: \\\"Rest Display Name\\\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`.\n- `spec_type.enum_values.values.id: grpc-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 spec_type attribute is *grpc-id* and the spec was created before *2021-08-15 14:50:00 UTC* and after *2021-08-10 12:00:00 UTC*.\n- `spec_type.enum_values.values.id: rest-id OR\n spec_type.enum_values.values.id: grpc-id`\n- The id of the allowed value associated with the spec_type attribute is *rest-id* or *grpc-id*.\n\n### setFilter\n\nOptional. An expression that filters the list of Specs.\n\nA filter expression consists of a field name, a comparison\noperator, and a value for filtering. The value must be a string. The\ncomparison operator must be one of: `\u003c`, `\u003e`, `:` or `=`. Filters are not\ncase sensitive.\nThe following fields in the `Spec` are eligible for filtering:\n\n- `display_name` - The display name of the Spec. Allowed comparison operators: `=`.\n- `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`.\n- `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`.\n- `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`.\n- `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`.\n- `mime_type` - The MIME type of the Spec. 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- `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is *rest-id*.\n- `spec_type.enum_values.values.display_name: \\\"Rest Display Name\\\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`.\n- `spec_type.enum_values.values.id: grpc-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 spec_type attribute is *grpc-id* and the spec was created before *2021-08-15 14:50:00 UTC* and after *2021-08-10 12:00:00 UTC*.\n- `spec_type.enum_values.values.id: rest-id OR\n spec_type.enum_values.values.id: grpc-id`\n- The id of the allowed value associated with the spec_type attribute is *rest-id* or *grpc-id*.\n\n### getPageSize\n\nOptional. The maximum number of specs to return. The service may return\nfewer than this value. If unspecified, at most 50 specs 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 specs to return. The service may return\nfewer than this value. If unspecified, at most 50 specs 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 `ListSpecs` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListSpecs` must\nmatch the call that provided the page token.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListSpecs` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListSpecs` must\nmatch the call that provided the page token.\n\n### static::build"]]
