Interface ListEntriesRequestOrBuilder

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

@Generated public interface ListEntriesRequestOrBuilder 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 resource name of the parent Entry Group:
       `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.
    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the parent Entry Group:
       `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.
    • getPageSize

      int getPageSize()
       Optional. Number of items to return per page. If there are remaining
       results, the service returns a next_page_token. If unspecified, the service
       returns at most 10 Entries. The maximum value is 100; values above 100 will
       be coerced to 100.
       
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.
    • getPageToken

      String getPageToken()
       Optional. Page token received from a previous `ListEntries` call. Provide
       this to retrieve the subsequent page.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.
    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Page token received from a previous `ListEntries` call. Provide
       this to retrieve the subsequent page.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.
    • getFilter

      String getFilter()
       Optional. A filter on the entries to return. Filters are case-sensitive.
       You can filter the request by the following fields:
      
       * entry_type
       * entry_source.display_name
       * parent_entry
      
       The comparison operators are =, !=, <, >, <=, >=. The service compares
       strings according to lexical order.
      
       You can use the logical operators AND, OR, NOT in the filter.
      
       You can use Wildcard "*", but for entry_type and parent_entry you need to
       provide the full project id or number.
      
       You cannot use parent_entry in conjunction with other fields.
      
       Example filter expressions:
      
       * "entry_source.display_name=AnExampleDisplayName"
       * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
       * "entry_type=projects/example-project/locations/us/entryTypes/a* OR
       entry_type=projects/another-project/locations/*"
       * "NOT entry_source.display_name=AnotherExampleDisplayName"
       * "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.
    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. A filter on the entries to return. Filters are case-sensitive.
       You can filter the request by the following fields:
      
       * entry_type
       * entry_source.display_name
       * parent_entry
      
       The comparison operators are =, !=, <, >, <=, >=. The service compares
       strings according to lexical order.
      
       You can use the logical operators AND, OR, NOT in the filter.
      
       You can use Wildcard "*", but for entry_type and parent_entry you need to
       provide the full project id or number.
      
       You cannot use parent_entry in conjunction with other fields.
      
       Example filter expressions:
      
       * "entry_source.display_name=AnExampleDisplayName"
       * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
       * "entry_type=projects/example-project/locations/us/entryTypes/a* OR
       entry_type=projects/another-project/locations/*"
       * "NOT entry_source.display_name=AnotherExampleDisplayName"
       * "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.