public sealed class ListApisRequest : IPageRequest, IMessage<ListApisRequest>, IEquatable<ListApisRequest>, IDeepCloneable<ListApisRequest>, IBufferMessage, IMessageReference documentation and code samples for the API hub v1 API class ListApisRequest.
The [ListApis][google.cloud.apihub.v1.ApiHub.ListApis] method's request.
Implements
IPageRequest, IMessageListApisRequest, IEquatableListApisRequest, IDeepCloneableListApisRequest, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
ListApisRequest()
public ListApisRequest()ListApisRequest(ListApisRequest)
public ListApisRequest(ListApisRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListApisRequest |
Properties
Filter
public string Filter { get; set; }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 isApiHub Team.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PageSize
public int PageSize { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int |
|
PageToken
public string PageToken { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Parent
public string Parent { get; set; }Required. The parent, which owns this collection of API resources.
Format: projects/{project}/locations/{location}
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentAsLocationName
public LocationName ParentAsLocationName { get; set; }LocationName-typed view over the Parent resource name property.
| Property Value | |
|---|---|
| Type | Description |
LocationName |
|