Generated from protobuf message google.cloud.apihub.v1.ListAttributesRequest
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 resource for Attribute. Format: projects/{project}/locations/{location}
↳ filter
string
Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the Attribute are eligible for filtering: * * display_name - The display name of the Attribute. Allowed comparison operators: =. * * definition_type - The definition type of the attribute. Allowed comparison operators: =. * * scope - The scope of the attribute. Allowed comparison operators: =. * * data_type - The type of the data of the attribute. Allowed comparison operators: =. * * mandatory - Denotes whether the attribute is mandatory or not. Allowed comparison operators: =. * * create_time - The time at which the Attribute was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. 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: * * display_name = production - - The display name of the attribute is production. * * (display_name = production) AND (create_time < \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\") - The display name of the attribute is production and the attribute was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * * display_name = production OR scope = api - The attribute where the display name is production or the scope is api.
↳ page_size
int
Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes 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 ListAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAttributes must match the call that provided the page token.
getParent
Required. The parent resource for Attribute.
Format: projects/{project}/locations/{location}
Returns
Type
Description
string
setParent
Required. The parent resource for Attribute.
Format: projects/{project}/locations/{location}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. An expression that filters the list of Attributes.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string or a
boolean. The comparison operator must be one of: <, > or
=. Filters are not case sensitive.
The following fields in the Attribute are eligible for filtering:
display_name - The display name of the Attribute. Allowed
comparison operators: =.
definition_type - The definition type of the attribute. Allowed
comparison operators: =.
scope - The scope of the attribute. Allowed comparison operators:
=.
data_type - The type of the data of the attribute. Allowed
comparison operators: =.
mandatory - Denotes whether the attribute is mandatory or not.
Allowed comparison operators: =.
create_time - The time at which the Attribute was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
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:
display_name = production - - The display name of the attribute is
production.
(display_name = production) AND (create_time <
\"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\") -
The display name of the attribute is production and the attribute was
created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00
UTC.
display_name = production OR scope = api -
The attribute where the display name is production or the scope is
api.
Returns
Type
Description
string
setFilter
Optional. An expression that filters the list of Attributes.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string or a
boolean. The comparison operator must be one of: <, > or
=. Filters are not case sensitive.
The following fields in the Attribute are eligible for filtering:
display_name - The display name of the Attribute. Allowed
comparison operators: =.
definition_type - The definition type of the attribute. Allowed
comparison operators: =.
scope - The scope of the attribute. Allowed comparison operators:
=.
data_type - The type of the data of the attribute. Allowed
comparison operators: =.
mandatory - Denotes whether the attribute is mandatory or not.
Allowed comparison operators: =.
create_time - The time at which the Attribute was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
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:
display_name = production - - The display name of the attribute is
production.
(display_name = production) AND (create_time <
\"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\") -
The display name of the attribute is production and the attribute was
created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00
UTC.
display_name = production OR scope = api -
The attribute where the display name is production or the scope is
api.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of attribute resources to return. The service
may return fewer than this value. If unspecified, at most 50 attributes
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 attribute resources to return. The service
may return fewer than this value. If unspecified, at most 50 attributes
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 ListAttributes call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAttributes must
match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previous ListAttributes call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAttributes 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 resource for Attribute.
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-08-28 UTC."],[],[],null,["# Google Cloud Api Hub V1 Client - Class ListAttributesRequest (0.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.2.1 (latest)](/php/docs/reference/cloud-apihub/latest/V1.ListAttributesRequest)\n- [0.2.0](/php/docs/reference/cloud-apihub/0.2.0/V1.ListAttributesRequest)\n- [0.1.4](/php/docs/reference/cloud-apihub/0.1.4/V1.ListAttributesRequest) \nReference documentation and code samples for the Google Cloud Api Hub V1 Client class ListAttributesRequest.\n\nThe [ListAttributes](/php/docs/reference/cloud-apihub/latest/V1.Client.ApiHubClient#_Google_Cloud_ApiHub_V1_Client_ApiHubClient__listAttributes__) method's\nrequest.\n\nGenerated from protobuf message `google.cloud.apihub.v1.ListAttributesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ApiHub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent resource for Attribute.\n\nFormat: `projects/{project}/locations/{location}`\n\n### setParent\n\nRequired. The parent resource for Attribute.\n\nFormat: `projects/{project}/locations/{location}`\n\n### getFilter\n\nOptional. An expression that filters the list of Attributes.\n\nA filter expression consists of a field name, a comparison\noperator, and a value for filtering. The value must be a string or a\nboolean. The comparison operator must be one of: `\u003c`, `\u003e` or\n`=`. Filters are not case sensitive.\nThe following fields in the `Attribute` are eligible for filtering:\n\n- `display_name` - The display name of the Attribute. Allowed comparison operators: `=`.\n- `definition_type` - The definition type of the attribute. Allowed comparison operators: `=`.\n- `scope` - The scope of the attribute. Allowed comparison operators: `=`.\n- `data_type` - The type of the data of the attribute. Allowed comparison operators: `=`.\n- `mandatory` - Denotes whether the attribute is mandatory or not. Allowed comparison operators: `=`.\n- `create_time` - The time at which the Attribute was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`. 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- `display_name = production` - - The display name of the attribute is *production*.\n- `(display_name = production) AND (create_time \u003c\n \\\"2021-08-15T14:50:00Z\\\") AND (create_time \u003e \\\"2021-08-10T12:00:00Z\\\")` - The display name of the attribute is *production* and the attribute was created before *2021-08-15 14:50:00 UTC* and after *2021-08-10 12:00:00\n UTC*.\n- `display_name = production OR scope = api` - The attribute where the display name is *production* or the scope is *api*.\n\n### setFilter\n\nOptional. An expression that filters the list of Attributes.\n\nA filter expression consists of a field name, a comparison\noperator, and a value for filtering. The value must be a string or a\nboolean. The comparison operator must be one of: `\u003c`, `\u003e` or\n`=`. Filters are not case sensitive.\nThe following fields in the `Attribute` are eligible for filtering:\n\n- `display_name` - The display name of the Attribute. Allowed comparison operators: `=`.\n- `definition_type` - The definition type of the attribute. Allowed comparison operators: `=`.\n- `scope` - The scope of the attribute. Allowed comparison operators: `=`.\n- `data_type` - The type of the data of the attribute. Allowed comparison operators: `=`.\n- `mandatory` - Denotes whether the attribute is mandatory or not. Allowed comparison operators: `=`.\n- `create_time` - The time at which the Attribute was created. The value should be in the (RFC3339)\\[\u003chttps://tools.ietf.org/html/rfc3339\u003e\\] format. Allowed comparison operators: `\u003e` and `\u003c`. 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- `display_name = production` - - The display name of the attribute is *production*.\n- `(display_name = production) AND (create_time \u003c\n \\\"2021-08-15T14:50:00Z\\\") AND (create_time \u003e \\\"2021-08-10T12:00:00Z\\\")` - The display name of the attribute is *production* and the attribute was created before *2021-08-15 14:50:00 UTC* and after *2021-08-10 12:00:00\n UTC*.\n- `display_name = production OR scope = api` - The attribute where the display name is *production* or the scope is *api*.\n\n### getPageSize\n\nOptional. The maximum number of attribute resources to return. The service\nmay return fewer than this value. If unspecified, at most 50 attributes\nwill be returned. The maximum value is 1000; values above 1000 will be\ncoerced to 1000.\n\n### setPageSize\n\nOptional. The maximum number of attribute resources to return. The service\nmay return fewer than this value. If unspecified, at most 50 attributes\nwill be returned. The maximum value is 1000; values above 1000 will be\ncoerced to 1000.\n\n### getPageToken\n\nOptional. A page token, received from a previous `ListAttributes` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListAttributes` must\nmatch the call that provided the page token.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListAttributes` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListAttributes` must\nmatch the call that provided the page token.\n\n### static::build"]]
