Class ListEntriesRequest.Builder (1.42.0)

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

Request message for ListEntries.

Protobuf type google.cloud.datacatalog.v1.ListEntriesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListEntriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

build()

public ListEntriesRequest build()
Returns
TypeDescription
ListEntriesRequest

buildPartial()

public ListEntriesRequest buildPartial()
Returns
TypeDescription
ListEntriesRequest

clear()

public ListEntriesRequest.Builder clear()
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListEntriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListEntriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

clearPageSize()

public ListEntriesRequest.Builder clearPageSize()

The maximum number of items to return. Default is 10. Maximum limit is

  1. Throws an invalid argument if page_size is more than 1000.

int32 page_size = 2;

Returns
TypeDescription
ListEntriesRequest.Builder

This builder for chaining.

clearPageToken()

public ListEntriesRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
TypeDescription
ListEntriesRequest.Builder

This builder for chaining.

clearParent()

public ListEntriesRequest.Builder clearParent()

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
TypeDescription
ListEntriesRequest.Builder

This builder for chaining.

clearReadMask()

public ListEntriesRequest.Builder clearReadMask()

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
TypeDescription
ListEntriesRequest.Builder

clone()

public ListEntriesRequest.Builder clone()
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListEntriesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListEntriesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

The maximum number of items to return. Default is 10. Maximum limit is

  1. Throws an invalid argument if page_size is more than 1000.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

public 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
TypeDescription
ByteString

The bytes for parent.

getReadMask()

public 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
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

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
TypeDescription
Builder

getReadMaskOrBuilder()

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

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public 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
TypeDescription
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListEntriesRequest other)

public ListEntriesRequest.Builder mergeFrom(ListEntriesRequest other)
Parameter
NameDescription
otherListEntriesRequest
Returns
TypeDescription
ListEntriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEntriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListEntriesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListEntriesRequest.Builder mergeReadMask(FieldMask value)

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;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListEntriesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListEntriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListEntriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

setPageSize(int value)

public ListEntriesRequest.Builder setPageSize(int value)

The maximum number of items to return. Default is 10. Maximum limit is

  1. Throws an invalid argument if page_size is more than 1000.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListEntriesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEntriesRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListEntriesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEntriesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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 to list.

Can be provided in URL format.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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 to list.

Can be provided in URL format.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListEntriesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListEntriesRequest.Builder setReadMask(FieldMask value)

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;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListEntriesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListEntriesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListEntriesRequest.Builder

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

public ListEntriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListEntriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListEntriesRequest.Builder
Overrides