Interface ListAttributesRequestOrBuilder

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

@Generated public interface ListAttributesRequestOrBuilder 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 for Attribute.
       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 resource for Attribute.
       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 Attributes.
      
       A filter expression consists of a field name, a comparison
       operator, and a value for filtering. The value must be a string or a
       boolean. The comparison operator must be one of: `<`, `>` or
       `=`. Filters are not case sensitive.
      
       The following fields in the `Attribute` are eligible for filtering:
      
       * `display_name` - The display name of the Attribute. Allowed
       comparison operators: `=`.
       * `definition_type` - The definition type of the attribute. Allowed
       comparison operators: `=`.
       * `scope` - The scope of the attribute. Allowed comparison operators:
       `=`.
       * `data_type` - The type of the data of the attribute. Allowed
       comparison operators: `=`.
       * `mandatory` - Denotes whether the attribute is mandatory or not.
       Allowed comparison operators: `=`.
       * `create_time` - The time at which the Attribute was created. The
       value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
       format. Allowed comparison operators: `>` and `<`.
      
       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:
      
       * `display_name = production` -  - The display name of the attribute is
       _production_.
       * `(display_name = production) AND (create_time <
       \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\")` -
       The display name of the attribute is _production_ and the attribute was
       created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00
       UTC_.
       * `display_name = production OR scope = api` -
       The attribute where the display name is _production_ or the scope is
       _api_.
       
      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 Attributes.
      
       A filter expression consists of a field name, a comparison
       operator, and a value for filtering. The value must be a string or a
       boolean. The comparison operator must be one of: `<`, `>` or
       `=`. Filters are not case sensitive.
      
       The following fields in the `Attribute` are eligible for filtering:
      
       * `display_name` - The display name of the Attribute. Allowed
       comparison operators: `=`.
       * `definition_type` - The definition type of the attribute. Allowed
       comparison operators: `=`.
       * `scope` - The scope of the attribute. Allowed comparison operators:
       `=`.
       * `data_type` - The type of the data of the attribute. Allowed
       comparison operators: `=`.
       * `mandatory` - Denotes whether the attribute is mandatory or not.
       Allowed comparison operators: `=`.
       * `create_time` - The time at which the Attribute was created. The
       value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
       format. Allowed comparison operators: `>` and `<`.
      
       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:
      
       * `display_name = production` -  - The display name of the attribute is
       _production_.
       * `(display_name = production) AND (create_time <
       \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\")` -
       The display name of the attribute is _production_ and the attribute was
       created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00
       UTC_.
       * `display_name = production OR scope = api` -
       The attribute where the display name is _production_ or the scope is
       _api_.
       
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.
    • getPageSize

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