Class ListEntriesRequest.Builder (1.54.0)

public static final class ListEntriesRequest.Builder extends GeneratedMessageV3.Builder<ListEntriesRequest.Builder> implements ListEntriesRequestOrBuilder

Request message for ListEntries.

Protobuf type google.cloud.datacatalog.v1beta1.ListEntriesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListEntriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEntriesRequest.Builder
Overrides

build()

public ListEntriesRequest build()
Returns
Type Description
ListEntriesRequest

buildPartial()

public ListEntriesRequest buildPartial()
Returns
Type Description
ListEntriesRequest

clear()

public ListEntriesRequest.Builder clear()
Returns
Type Description
ListEntriesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListEntriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListEntriesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListEntriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListEntriesRequest.Builder
Overrides

clearPageSize()

public ListEntriesRequest.Builder clearPageSize()

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
Type Description
ListEntriesRequest.Builder

This builder for chaining.

clearPageToken()

public ListEntriesRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

clearParent()

public ListEntriesRequest.Builder clearParent()

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
Type Description
ListEntriesRequest.Builder

This builder for chaining.

clearReadMask()

public ListEntriesRequest.Builder clearReadMask()

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
Type Description
ListEntriesRequest.Builder

clone()

public ListEntriesRequest.Builder clone()
Returns
Type Description
ListEntriesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListEntriesRequest getDefaultInstanceForType()
Returns
Type Description
ListEntriesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

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

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

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

The parent.

getParentBytes()

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

The bytes for parent.

getReadMask()

public 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
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

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
Type Description
Builder

getReadMaskOrBuilder()

public 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
Type Description
FieldMaskOrBuilder

hasReadMask()

public 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
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListEntriesRequest other)

public ListEntriesRequest.Builder mergeFrom(ListEntriesRequest other)
Parameter
Name Description
other ListEntriesRequest
Returns
Type Description
ListEntriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEntriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEntriesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListEntriesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListEntriesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListEntriesRequest.Builder mergeReadMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListEntriesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListEntriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEntriesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListEntriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEntriesRequest.Builder
Overrides

setPageSize(int value)

public ListEntriesRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEntriesRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEntriesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

setParent(String value)

public ListEntriesRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEntriesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListEntriesRequest.Builder setReadMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListEntriesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListEntriesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListEntriesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListEntriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListEntriesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListEntriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEntriesRequest.Builder
Overrides