API hub V1 API - Class Google::Cloud::ApiHub::V1::ListAttributesRequest (v0.3.0)

Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::ListAttributesRequest.

The ListAttributes method's request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    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.
Returns
  • (::String) —

    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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — 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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}
Returns
  • (::String) — Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}