Google Cloud Api Hub V1 Client - Class ListPluginsRequest (0.3.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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}.

Returns
Type Description
string

setParent

Required. The parent resource where this plugin will be created.

Format: projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$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 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.
Returns
Type Description
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 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.
Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
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.
Returns
Type Description
ListPluginsRequest