Class ListPluginInstancesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.ListPluginInstancesRequest
All Implemented Interfaces:
ListPluginInstancesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ListPluginInstancesRequest extends com.google.protobuf.GeneratedMessage implements ListPluginInstancesRequestOrBuilder
 The
 [ListPluginInstances][google.cloud.apihub.v1.ApiHubPlugin.ListPluginInstances]
 method's request.
 
Protobuf type google.cloud.apihub.v1.ListPluginInstancesRequest
See Also:
  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ListPluginInstancesRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListPluginInstancesRequestOrBuilder
      Returns:
      The bytes for parent.
    • getFilter

      public 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];
      Specified by:
      getFilter in interface ListPluginInstancesRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface ListPluginInstancesRequestOrBuilder
      Returns:
      The bytes for filter.
    • getPageSize

      public 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];
      Specified by:
      getPageSize in interface ListPluginInstancesRequestOrBuilder
      Returns:
      The pageSize.
    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface ListPluginInstancesRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface ListPluginInstancesRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ListPluginInstancesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ListPluginInstancesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListPluginInstancesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public ListPluginInstancesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static ListPluginInstancesRequest.Builder newBuilder()
    • newBuilder

      public static ListPluginInstancesRequest.Builder newBuilder(ListPluginInstancesRequest prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected ListPluginInstancesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ListPluginInstancesRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ListPluginInstancesRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<ListPluginInstancesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public ListPluginInstancesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder