Interface ListEntriesRequestOrBuilder (1.40.0)

public interface ListEntriesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract int getPageSize()

The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for page_size > 1000.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Token that specifies which page is requested. If empty, the first page is returned.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Token that specifies which page is requested. If empty, the first page is returned.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The name of the entry group that contains the entries, which can be provided in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The name of the entry group that contains the entries, which can be provided in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getReadMask()

public abstract FieldMask getReadMask()

The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting read_mask to contain only one path "name" will cause ListEntries to return a list of Entries with only "name" field.

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskOrBuilder()

public abstract FieldMaskOrBuilder getReadMaskOrBuilder()

The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting read_mask to contain only one path "name" will cause ListEntries to return a list of Entries with only "name" field.

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public abstract boolean hasReadMask()

The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting read_mask to contain only one path "name" will cause ListEntries to return a list of Entries with only "name" field.

.google.protobuf.FieldMask read_mask = 4;

Returns
TypeDescription
boolean

Whether the readMask field is set.