Generated from protobuf message google.cloud.apihub.v1.ListApisRequest
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 resources. Format: projects/{project}/locations/{location}
↳ filter
string
Optional. An expression that filters the list of ApiResources. 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 ApiResource are eligible for filtering: * * owner.email - The email of the team which owns the ApiResource. Allowed comparison operators: =. * * create_time - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * * display_name - The display name of the ApiResource. Allowed comparison operators: =. * * target_user.enum_values.values.id - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is :. * * target_user.enum_values.values.display_name - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is :. * * team.enum_values.values.id - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is :. * * team.enum_values.values.display_name - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is :. * * business_unit.enum_values.values.id - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is :. * * business_unit.enum_values.values.display_name - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is :. * * maturity_level.enum_values.values.id - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is :. * * maturity_level.enum_values.values.display_name - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is :. * * api_style.enum_values.values.id - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is :. * * api_style.enum_values.values.display_name - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is :. 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: * * owner.email = \"apihub@google.com\" - - The owner team email is _apihub@google.com_. * * owner.email = \"apihub@google.com\" AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The owner team email is _apihub@google.com_ and the api was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * * owner.email = \"apihub@google.com\" OR team.enum_values.values.id: apihub-team-id - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is apihub-team-id. * * owner.email = \"apihub@google.com\" OR team.enum_values.values.display_name: ApiHub Team - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is ApiHub Team.
↳ page_size
int
Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis 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 ListApis call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListApis must match the call that provided the page token.
getParent
Required. The parent, which owns this collection of API resources.
Format: projects/{project}/locations/{location}
Returns
Type
Description
string
setParent
Required. The parent, which owns this collection of API resources.
Format: projects/{project}/locations/{location}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. An expression that filters the list of ApiResources.
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 ApiResource are eligible for filtering:
owner.email - The email of the team which owns the ApiResource.
Allowed comparison operators: =.
create_time - The time at which the ApiResource was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
display_name - The display name of the ApiResource. Allowed
comparison operators: =.
target_user.enum_values.values.id - The allowed value id of the
target users attribute associated with the ApiResource. Allowed
comparison operator is :.
target_user.enum_values.values.display_name - The allowed value
display name of the target users attribute associated with the
ApiResource. Allowed comparison operator is :.
team.enum_values.values.id - The allowed value id of the team
attribute associated with the ApiResource. Allowed comparison operator is
:.
team.enum_values.values.display_name - The allowed value display name
of the team attribute associated with the ApiResource. Allowed comparison
operator is :.
business_unit.enum_values.values.id - The allowed value id of the
business unit attribute associated with the ApiResource. Allowed
comparison operator is :.
business_unit.enum_values.values.display_name - The allowed value
display name of the business unit attribute associated with the
ApiResource. Allowed comparison operator is :.
maturity_level.enum_values.values.id - The allowed value id of the
maturity level attribute associated with the ApiResource. Allowed
comparison operator is :.
maturity_level.enum_values.values.display_name - The allowed value
display name of the maturity level attribute associated with the
ApiResource. Allowed comparison operator is :.
api_style.enum_values.values.id - The allowed value id of the
api style attribute associated with the ApiResource. Allowed
comparison operator is :.
api_style.enum_values.values.display_name - The allowed value display
name of the api style attribute associated with the ApiResource. Allowed
comparison operator is :.
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:
owner.email = \"apihub@google.com\" - - The owner team email is
_apihub@google.com_.
owner.email = \"apihub@google.com\" AND create_time <
\"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" -
The owner team email is _apihub@google.com_ and the api was created
before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
owner.email = \"apihub@google.com\" OR team.enum_values.values.id:
apihub-team-id - The filter string specifies the APIs where the owner
team email is _apihub@google.com_ or the id of the allowed value
associated with the team attribute is apihub-team-id.
owner.email = \"apihub@google.com\" OR
team.enum_values.values.display_name: ApiHub Team - The filter string
specifies the APIs where the owner team email is _apihub@google.com_ or
the display name of the allowed value associated with the team attribute
is ApiHub Team.
Returns
Type
Description
string
setFilter
Optional. An expression that filters the list of ApiResources.
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 ApiResource are eligible for filtering:
owner.email - The email of the team which owns the ApiResource.
Allowed comparison operators: =.
create_time - The time at which the ApiResource was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
display_name - The display name of the ApiResource. Allowed
comparison operators: =.
target_user.enum_values.values.id - The allowed value id of the
target users attribute associated with the ApiResource. Allowed
comparison operator is :.
target_user.enum_values.values.display_name - The allowed value
display name of the target users attribute associated with the
ApiResource. Allowed comparison operator is :.
team.enum_values.values.id - The allowed value id of the team
attribute associated with the ApiResource. Allowed comparison operator is
:.
team.enum_values.values.display_name - The allowed value display name
of the team attribute associated with the ApiResource. Allowed comparison
operator is :.
business_unit.enum_values.values.id - The allowed value id of the
business unit attribute associated with the ApiResource. Allowed
comparison operator is :.
business_unit.enum_values.values.display_name - The allowed value
display name of the business unit attribute associated with the
ApiResource. Allowed comparison operator is :.
maturity_level.enum_values.values.id - The allowed value id of the
maturity level attribute associated with the ApiResource. Allowed
comparison operator is :.
maturity_level.enum_values.values.display_name - The allowed value
display name of the maturity level attribute associated with the
ApiResource. Allowed comparison operator is :.
api_style.enum_values.values.id - The allowed value id of the
api style attribute associated with the ApiResource. Allowed
comparison operator is :.
api_style.enum_values.values.display_name - The allowed value display
name of the api style attribute associated with the ApiResource. Allowed
comparison operator is :.
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:
owner.email = \"apihub@google.com\" - - The owner team email is
_apihub@google.com_.
owner.email = \"apihub@google.com\" AND create_time <
\"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" -
The owner team email is _apihub@google.com_ and the api was created
before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
owner.email = \"apihub@google.com\" OR team.enum_values.values.id:
apihub-team-id - The filter string specifies the APIs where the owner
team email is _apihub@google.com_ or the id of the allowed value
associated with the team attribute is apihub-team-id.
owner.email = \"apihub@google.com\" OR
team.enum_values.values.display_name: ApiHub Team - The filter string
specifies the APIs where the owner team email is _apihub@google.com_ or
the display name of the allowed value associated with the team attribute
is ApiHub Team.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of API resources to return. The service may
return fewer than this value. If unspecified, at most 50 Apis 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 API resources to return. The service may
return fewer than this value. If unspecified, at most 50 Apis 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 ListApis call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListApis must match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previous ListApis call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListApis 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 resources.
Format: projects/{project}/locations/{location}
Please see ApiHubClient::locationName() 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 ListApisRequest (0.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.2.1 (latest)](/php/docs/reference/cloud-apihub/latest/V1.ListApisRequest)\n- [0.2.0](/php/docs/reference/cloud-apihub/0.2.0/V1.ListApisRequest)\n- [0.1.4](/php/docs/reference/cloud-apihub/0.1.4/V1.ListApisRequest) \nReference documentation and code samples for the Google Cloud Api Hub V1 Client class ListApisRequest.\n\nThe [ListApis](/php/docs/reference/cloud-apihub/latest/V1.Client.ApiHubClient#_Google_Cloud_ApiHub_V1_Client_ApiHubClient__listApis__) method's request.\n\nGenerated from protobuf message `google.cloud.apihub.v1.ListApisRequest`\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 resources.\n\nFormat: `projects/{project}/locations/{location}`\n\n### setParent\n\nRequired. The parent, which owns this collection of API resources.\n\nFormat: `projects/{project}/locations/{location}`\n\n### getFilter\n\nOptional. An expression that filters the list of ApiResources.\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 `ApiResource` are eligible for filtering:\n\n- `owner.email` - The email of the team which owns the ApiResource. Allowed comparison operators: `=`.\n- `create_time` - The time at which the ApiResource was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`.\n- `display_name` - The display name of the ApiResource. Allowed comparison operators: `=`.\n- `target_user.enum_values.values.id` - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `target_user.enum_values.values.display_name` - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `team.enum_values.values.id` - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `team.enum_values.values.display_name` - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `business_unit.enum_values.values.id` - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `business_unit.enum_values.values.display_name` - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `maturity_level.enum_values.values.id` - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `maturity_level.enum_values.values.display_name` - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `api_style.enum_values.values.id` - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `api_style.enum_values.values.display_name` - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. 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- `owner.email = \\\"apihub@google.com\\\"` - - The owner team email is _apihub@google.com_.\n- `owner.email = \\\"apihub@google.com\\\" AND create_time \u003c\n \\\"2021-08-15T14:50:00Z\\\" AND create_time \u003e \\\"2021-08-10T12:00:00Z\\\"` - The owner team email is _apihub@google.com_ and the api was created before *2021-08-15 14:50:00 UTC* and after *2021-08-10 12:00:00 UTC*.\n- `owner.email = \\\"apihub@google.com\\\" OR team.enum_values.values.id:\n apihub-team-id` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is *apihub-team-id*.\n- `owner.email = \\\"apihub@google.com\\\" OR\n team.enum_values.values.display_name: ApiHub Team` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is `ApiHub Team`.\n\n### setFilter\n\nOptional. An expression that filters the list of ApiResources.\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 `ApiResource` are eligible for filtering:\n\n- `owner.email` - The email of the team which owns the ApiResource. Allowed comparison operators: `=`.\n- `create_time` - The time at which the ApiResource was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`.\n- `display_name` - The display name of the ApiResource. Allowed comparison operators: `=`.\n- `target_user.enum_values.values.id` - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `target_user.enum_values.values.display_name` - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `team.enum_values.values.id` - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `team.enum_values.values.display_name` - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `business_unit.enum_values.values.id` - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `business_unit.enum_values.values.display_name` - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `maturity_level.enum_values.values.id` - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `maturity_level.enum_values.values.display_name` - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `api_style.enum_values.values.id` - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`.\n- `api_style.enum_values.values.display_name` - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. 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- `owner.email = \\\"apihub@google.com\\\"` - - The owner team email is _apihub@google.com_.\n- `owner.email = \\\"apihub@google.com\\\" AND create_time \u003c\n \\\"2021-08-15T14:50:00Z\\\" AND create_time \u003e \\\"2021-08-10T12:00:00Z\\\"` - The owner team email is _apihub@google.com_ and the api was created before *2021-08-15 14:50:00 UTC* and after *2021-08-10 12:00:00 UTC*.\n- `owner.email = \\\"apihub@google.com\\\" OR team.enum_values.values.id:\n apihub-team-id` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is *apihub-team-id*.\n- `owner.email = \\\"apihub@google.com\\\" OR\n team.enum_values.values.display_name: ApiHub Team` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is `ApiHub Team`.\n\n### getPageSize\n\nOptional. The maximum number of API resources to return. The service may\nreturn fewer than this value. If unspecified, at most 50 Apis 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 API resources to return. The service may\nreturn fewer than this value. If unspecified, at most 50 Apis 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 `ListApis` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters (except page_size) provided to\n`ListApis` must match the call that provided the page token.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListApis` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters (except page_size) provided to\n`ListApis` must match the call that provided the page token.\n\n### static::build"]]
