public sealed class ListPluginsRequest : IPageRequest, IMessage<ListPluginsRequest>, IEquatable<ListPluginsRequest>, IDeepCloneable<ListPluginsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the API hub v1 API class ListPluginsRequest.
The [ListPlugins][google.cloud.apihub.v1.ApiHubPlugin.ListPlugins] method's request.
Implements
IPageRequest, IMessageListPluginsRequest, IEquatableListPluginsRequest, IDeepCloneableListPluginsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
ListPluginsRequest()
public ListPluginsRequest()
ListPluginsRequest(ListPluginsRequest)
public ListPluginsRequest(ListPluginsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListPluginsRequest |
Properties
Filter
public string Filter { get; set; }
Optional. An expression that filters the list of plugins.
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 Plugins
are eligible for filtering:
plugin_category
- The category of the Plugin. 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:
plugin_category = ON_RAMP
- The plugin is of category on ramp.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins 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 ListPlugins
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListPlugins
must match the call that provided the page token.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The parent resource where this plugin will be created.
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 |