Interface ListEntriesRequestOrBuilder (1.53.0)

public interface ListEntriesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract 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

    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 you need to provide the full project id or number.

    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"

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract 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

    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 you need to provide the full project id or number.

    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"

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract 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
Type Description
int

The pageSize.

getPageToken()

public abstract 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
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract 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
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract 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
Type Description
String

The parent.

getParentBytes()

public abstract 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
Type Description
ByteString

The bytes for parent.