Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ListAttributesRequest.
The ListAttributes method's request.
Generated from protobuf message google.cloud.apihub.v1.ListAttributesRequest
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource for Attribute. Format: |
↳ 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: |
↳ 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 |
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 eitherAND
logic operator orOR
logical operator but not both of them together i.e. only one of theAND
orOR
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 thenINVALID_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 eitherAND
logic operator orOR
logical operator but not both of them together i.e. only one of theAND
orOR
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 thenINVALID_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: |
Returns | |
---|---|
Type | Description |
Google\Cloud\ApiHub\V1\ListAttributesRequest |