Interface ListApisRequestOrBuilder

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

@Generated public interface ListApisRequestOrBuilder 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, which owns this collection of API resources.
       Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.
    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent, which owns this collection of API resources.
       Format: `projects/{project}/locations/{location}`
       
      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 ApiResources.
      
       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 `ApiResource` are eligible for filtering:
      
       * `owner.email` - The email of the team which owns the ApiResource.
       Allowed comparison operators: `=`.
       * `create_time` - The time at which the ApiResource was created. The
       value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
       format. Allowed comparison operators: `>` and `<`.
       * `display_name` - The display name of the ApiResource. Allowed
       comparison operators: `=`.
       * `target_user.enum_values.values.id` - The allowed value id of the
       target users attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `target_user.enum_values.values.display_name` - The allowed value
       display name of the target users attribute associated with the
       ApiResource. Allowed comparison operator is `:`.
       * `team.enum_values.values.id` - The allowed value id of the team
       attribute associated with the ApiResource. Allowed comparison operator is
       `:`.
       * `team.enum_values.values.display_name` - The allowed value display name
       of the team attribute associated with the ApiResource. Allowed comparison
       operator is `:`.
       * `business_unit.enum_values.values.id` - The allowed value id of the
       business unit attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `business_unit.enum_values.values.display_name` - The allowed value
       display name of the business unit attribute associated with the
       ApiResource. Allowed comparison operator is `:`.
       * `maturity_level.enum_values.values.id` - The allowed value id of the
       maturity level attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `maturity_level.enum_values.values.display_name` - The allowed value
       display name of the maturity level attribute associated with the
       ApiResource. Allowed comparison operator is `:`.
       * `api_style.enum_values.values.id` - The allowed value id of the
       api style attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `api_style.enum_values.values.display_name` - The allowed value display
       name of the api style attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.id` - The
       allowed value id of the user defined enum attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-id is a placeholder that can be replaced with
       any user defined enum attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.display_name`
       - The allowed value display name of the user defined enum attribute
       associated with the Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-display-name is a placeholder that can be
       replaced with any user defined enum attribute enum name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.string_values.values` - The
       allowed value of the user defined string attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-string is a placeholder that can be replaced with
       any user defined string attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.json_values.values` - The
       allowed value of the user defined JSON attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-json is a placeholder that can be replaced with
       any user defined JSON attribute name.
      
       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) = \"api-1\"` is equivalent to
       `name = \"projects/test-project-id/locations/test-location-id/apis/api-1\"`
       provided the parent is
       `projects/test-project-id/locations/test-location-id`.
      
       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:
      
       * `owner.email = \"apihub@google.com\"` -  - The owner team email is
       _apihub@google.com_.
       * `owner.email = \"apihub@google.com\" AND create_time <
       \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
       The owner team email is _apihub@google.com_ and the api was created
       before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
       * `owner.email = \"apihub@google.com\" OR team.enum_values.values.id:
       apihub-team-id` - The filter string specifies the APIs where the owner
       team email is _apihub@google.com_ or the id of the allowed value
       associated with the team attribute is _apihub-team-id_.
       * `owner.email = \"apihub@google.com\" OR
       team.enum_values.values.display_name: ApiHub Team` - The filter string
       specifies the APIs where the owner team email is _apihub@google.com_ or
       the display name of the allowed value associated with the team attribute
       is `ApiHub Team`.
       * `owner.email = \"apihub@google.com\" AND
       attributes.projects/test-project-id/locations/test-location-id/
       attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id:
       test_enum_id AND
       attributes.projects/test-project-id/locations/test-location-id/
       attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values:
       test_string_value`  - The filter string specifies the APIs where the
       owner team email is _apihub@google.com_ and the id of the allowed value
       associated with the user defined attribute of type enum is _test_enum_id_
       and the value of the user defined attribute of type string is _test_..
       
      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 ApiResources.
      
       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 `ApiResource` are eligible for filtering:
      
       * `owner.email` - The email of the team which owns the ApiResource.
       Allowed comparison operators: `=`.
       * `create_time` - The time at which the ApiResource was created. The
       value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
       format. Allowed comparison operators: `>` and `<`.
       * `display_name` - The display name of the ApiResource. Allowed
       comparison operators: `=`.
       * `target_user.enum_values.values.id` - The allowed value id of the
       target users attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `target_user.enum_values.values.display_name` - The allowed value
       display name of the target users attribute associated with the
       ApiResource. Allowed comparison operator is `:`.
       * `team.enum_values.values.id` - The allowed value id of the team
       attribute associated with the ApiResource. Allowed comparison operator is
       `:`.
       * `team.enum_values.values.display_name` - The allowed value display name
       of the team attribute associated with the ApiResource. Allowed comparison
       operator is `:`.
       * `business_unit.enum_values.values.id` - The allowed value id of the
       business unit attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `business_unit.enum_values.values.display_name` - The allowed value
       display name of the business unit attribute associated with the
       ApiResource. Allowed comparison operator is `:`.
       * `maturity_level.enum_values.values.id` - The allowed value id of the
       maturity level attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `maturity_level.enum_values.values.display_name` - The allowed value
       display name of the maturity level attribute associated with the
       ApiResource. Allowed comparison operator is `:`.
       * `api_style.enum_values.values.id` - The allowed value id of the
       api style attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `api_style.enum_values.values.display_name` - The allowed value display
       name of the api style attribute associated with the ApiResource. Allowed
       comparison operator is `:`.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.id` - The
       allowed value id of the user defined enum attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-id is a placeholder that can be replaced with
       any user defined enum attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.enum_values.values.display_name`
       - The allowed value display name of the user defined enum attribute
       associated with the Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-enum-display-name is a placeholder that can be
       replaced with any user defined enum attribute enum name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.string_values.values` - The
       allowed value of the user defined string attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-string is a placeholder that can be replaced with
       any user defined string attribute name.
       * `attributes.projects/test-project-id/locations/test-location-id/
       attributes/user-defined-attribute-id.json_values.values` - The
       allowed value of the user defined JSON attribute associated with the
       Resource. Allowed comparison operator is `:`. Here
       user-defined-attribute-json is a placeholder that can be replaced with
       any user defined JSON attribute name.
      
       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) = \"api-1\"` is equivalent to
       `name = \"projects/test-project-id/locations/test-location-id/apis/api-1\"`
       provided the parent is
       `projects/test-project-id/locations/test-location-id`.
      
       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:
      
       * `owner.email = \"apihub@google.com\"` -  - The owner team email is
       _apihub@google.com_.
       * `owner.email = \"apihub@google.com\" AND create_time <
       \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
       The owner team email is _apihub@google.com_ and the api was created
       before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
       * `owner.email = \"apihub@google.com\" OR team.enum_values.values.id:
       apihub-team-id` - The filter string specifies the APIs where the owner
       team email is _apihub@google.com_ or the id of the allowed value
       associated with the team attribute is _apihub-team-id_.
       * `owner.email = \"apihub@google.com\" OR
       team.enum_values.values.display_name: ApiHub Team` - The filter string
       specifies the APIs where the owner team email is _apihub@google.com_ or
       the display name of the allowed value associated with the team attribute
       is `ApiHub Team`.
       * `owner.email = \"apihub@google.com\" AND
       attributes.projects/test-project-id/locations/test-location-id/
       attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id:
       test_enum_id AND
       attributes.projects/test-project-id/locations/test-location-id/
       attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values:
       test_string_value`  - The filter string specifies the APIs where the
       owner team email is _apihub@google.com_ and the id of the allowed value
       associated with the user defined attribute of type enum is _test_enum_id_
       and the value of the user defined attribute of type string is _test_..
       
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.
    • getPageSize

      int getPageSize()
       Optional. The maximum number of API resources to return. The service may
       return fewer than this value. If unspecified, at most 50 Apis 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 `ListApis` call.
       Provide this to retrieve the subsequent page.
      
       When paginating, all other parameters (except page_size) provided to
       `ListApis` 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 `ListApis` call.
       Provide this to retrieve the subsequent page.
      
       When paginating, all other parameters (except page_size) provided to
       `ListApis` must match the call that provided the page token.
       
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.