Interface ListPluginInstancesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListPluginInstancesRequest, ListPluginInstancesRequest.Builder

@Generated public interface ListPluginInstancesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Optional.
    com.google.protobuf.ByteString
    Optional.
    int
    Optional.
    Optional.
    com.google.protobuf.ByteString
    Optional.
    Required.
    com.google.protobuf.ByteString
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getParent

      String 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.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.
    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       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.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.
    • getFilter

      String 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.
       
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.
    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       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.
       
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.
    • getPageSize

      int 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.
       
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.
    • getPageToken

      String 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.
       
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.
    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       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.
       
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.