com.google.cloud.datacatalog.v1

Interface ListEntriesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListEntriesRequest, ListEntriesRequest.Builder

public interface ListEntriesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getPageSize() The maximum number of items to return.
String	getPageToken() Pagination token that specifies the next page to return.
com.google.protobuf.ByteString	getPageTokenBytes() Pagination token that specifies the next page to return.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.FieldMask	getReadMask() The fields to return for each entry.
com.google.protobuf.FieldMaskOrBuilder	getReadMaskOrBuilder() The fields to return for each entry.
boolean	hasReadMask() The fields to return for each entry.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The name of the entry group that contains the entries to list.

 Can be provided in URL format.
 

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

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The name of the entry group that contains the entries to list.

 Can be provided in URL format.
 

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

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 The maximum number of items to return. Default is 10. Maximum limit is
 1000. Throws an invalid argument if `page_size` is more than 1000.
 

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

 Pagination token that specifies the next page to return. If empty, the
 first page is returned.
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 Pagination token that specifies the next page to return. If empty, the
 first page is returned.
 

string page_token = 3;

Returns:

The bytes for pageToken.

hasReadMask

boolean hasReadMask()

 The fields to return for each entry. If empty or omitted, all
 fields are returned.

 For example, to return a list of entries with only the `name` field,
 set `read_mask` to only one path with the `name` value.
 

.google.protobuf.FieldMask read_mask = 4;

Returns:

Whether the readMask field is set.

getReadMask

com.google.protobuf.FieldMask getReadMask()

 The fields to return for each entry. If empty or omitted, all
 fields are returned.

 For example, to return a list of entries with only the `name` field,
 set `read_mask` to only one path with the `name` value.
 

.google.protobuf.FieldMask read_mask = 4;

Returns:

The readMask.

getReadMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()

 The fields to return for each entry. If empty or omitted, all
 fields are returned.

 For example, to return a list of entries with only the `name` field,
 set `read_mask` to only one path with the `name` value.
 

.google.protobuf.FieldMask read_mask = 4;