public sealed class ListPluginInstancesRequest : IPageRequest, IMessage<ListPluginInstancesRequest>, IEquatable<ListPluginInstancesRequest>, IDeepCloneable<ListPluginInstancesRequest>, IBufferMessage, IMessageReference documentation and code samples for the API hub v1 API class ListPluginInstancesRequest.
The [ListPluginInstances][google.cloud.apihub.v1.ApiHubPlugin.ListPluginInstances] method's request.
Implements
IPageRequest, IMessageListPluginInstancesRequest, IEquatableListPluginInstancesRequest, IDeepCloneableListPluginInstancesRequest, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
ListPluginInstancesRequest()
public ListPluginInstancesRequest()ListPluginInstancesRequest(ListPluginInstancesRequest)
public ListPluginInstancesRequest(ListPluginInstancesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListPluginInstancesRequest |
Properties
Filter
public string Filter { get; set; }Optional. An expression that filters the list of plugin instances.
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 PluginInstances are eligible for filtering:
state- The state of the Plugin Instance. Allowed comparison operators:=.
A filter function is also supported in the filter string. The filter
function is id(name). The id(name) function returns the id of the
resource name. For example, id(name) = \"plugin-instance-1\" is
equivalent to name =
\"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"
provided the parent is
projects/test-project-id/locations/test-location-id/plugins/plugin-1.
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:
state = ENABLED- The plugin instance is in enabled state.
| 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 ListPluginInstances
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPluginInstances
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}/plugins/{plugin}.
To list plugin instances for multiple plugins,
use the - character instead of the plugin ID.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentAsPluginName
public PluginName ParentAsPluginName { get; set; }PluginName-typed view over the Parent resource name property.
| Property Value | |
|---|---|
| Type | Description |
PluginName |
|