Console
    Start free

    Google Cloud Api Hub V1 Client - Class ListPluginInstancesRequest (0.4.0)

    Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ListPluginInstancesRequest.

    The ListPluginInstances method's request.

    Generated from protobuf message google.cloud.apihub.v1.ListPluginInstancesRequest

    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}/plugins/{plugin} . To list plugin instances for multiple plugins, use the - character instead of the plugin ID.

    ↳ filter
    string

    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.

    ↳ 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 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.

    getParent

    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.

    Returns
    Type
    Description
    string

    setParent

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

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

    setFilter

    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.
    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 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.

    Returns
    Type
    Description
    string

    setPageToken

    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.

    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}/plugins/{plugin} . To list plugin instances for multiple plugins, use the - character instead of the plugin ID. Please see ApiHubPluginClient::pluginName() for help formatting this field.

    Returns
    Type
    Description
    ListPluginInstancesRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: