Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ListPluginsRequest.
The ListPlugins method's request.
Generated from protobuf message google.cloud.apihub.v1.ListPluginsRequest
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location}
.
↳ filter
string
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.
↳ page_size
int
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.
↳ page_token
string
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.
getParent
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}
.
string
setParent
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}
.
var
string
$this
getFilter
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 eitherANDlogic operator orORlogical operator but not both of them together i.e. only one of theANDorORoperator 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_ARGUMENTerror is returned by the API. Here are a few examples: -
plugin_category = ON_RAMP- The plugin is of category on ramp.
string
setFilter
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 eitherANDlogic operator orORlogical operator but not both of them together i.e. only one of theANDorORoperator 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_ARGUMENTerror is returned by the API. Here are a few examples: -
plugin_category = ON_RAMP- The plugin is of category on ramp.
var
string
$this
getPageSize
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.
int
setPageSize
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.
var
int
$this
getPageToken
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.
string
setPageToken
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.
var
string
$this
static::build
parent
string
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}
. Please see ApiHubPluginClient::locationName()
for help formatting this field.
