Class ListPluginInstancesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListPluginInstancesRequest.Builder>
com.google.cloud.apihub.v1.ListPluginInstancesRequest.Builder
All Implemented Interfaces:
ListPluginInstancesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListPluginInstancesRequest

public static final class ListPluginInstancesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListPluginInstancesRequest.Builder> implements ListPluginInstancesRequestOrBuilder
 The
 [ListPluginInstances][google.cloud.apihub.v1.ApiHubPlugin.ListPluginInstances]
 method's request.
 
Protobuf type google.cloud.apihub.v1.ListPluginInstancesRequest
  • 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.Builder<ListPluginInstancesRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListPluginInstancesRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListPluginInstancesRequest.Builder>
    • getDefaultInstanceForType

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

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

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

      public ListPluginInstancesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListPluginInstancesRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListPluginInstancesRequest.Builder>
    • mergeFrom

      public ListPluginInstancesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListPluginInstancesRequest.Builder>
      Throws:
      IOException
    • 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.
    • setParent

      public ListPluginInstancesRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.
    • clearParent

      public ListPluginInstancesRequest.Builder clearParent()
       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:
      This builder for chaining.
    • setParentBytes

      public ListPluginInstancesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.
    • 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.
    • setFilter

      public ListPluginInstancesRequest.Builder setFilter(String value)
       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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.
    • clearFilter

      public ListPluginInstancesRequest.Builder clearFilter()
       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:
      This builder for chaining.
    • setFilterBytes

      public ListPluginInstancesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.
    • 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.
    • setPageSize

      public ListPluginInstancesRequest.Builder setPageSize(int value)
       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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • clearPageSize

      public ListPluginInstancesRequest.Builder clearPageSize()
       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:
      This builder for chaining.
    • 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.
    • setPageToken

      public ListPluginInstancesRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.
    • clearPageToken

      public ListPluginInstancesRequest.Builder clearPageToken()
       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:
      This builder for chaining.
    • setPageTokenBytes

      public ListPluginInstancesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.