Class ListEntriesRequest.Builder (1.85.0) 

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

List Entries request.

Protobuf type google.cloud.dataplex.v1.ListEntriesRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListEntriesRequest.Builder

Static Methods

getDescriptor()

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

Methods

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

clearFilter()

public ListEntriesRequest.Builder clearFilter()

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

  • parent_entry

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

    You cannot use parent_entry in conjunction with other fields.

    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"
  • "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"

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

Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

clearPageSize()

public ListEntriesRequest.Builder clearPageSize()

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

This builder for chaining.

clearPageToken()

public ListEntriesRequest.Builder clearPageToken()

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

This builder for chaining.

clearParent()

public ListEntriesRequest.Builder clearParent()

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

This builder for chaining.

getDefaultInstanceForType()

public ListEntriesRequest getDefaultInstanceForType()
Returns
Type Description
ListEntriesRequest

getDescriptorForType()

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

getFilter()

public 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

  • parent_entry

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

    You cannot use parent_entry in conjunction with other fields.

    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"
  • "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"

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

Returns
Type Description
String

The filter.

getFilterBytes()

public 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

  • parent_entry

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

    You cannot use parent_entry in conjunction with other fields.

    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"
  • "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

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

internalGetFieldAccessorTable()

protected GeneratedMessage.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

setFilter(String value)

public ListEntriesRequest.Builder setFilter(String value)

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

  • parent_entry

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

    You cannot use parent_entry in conjunction with other fields.

    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"
  • "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListEntriesRequest.Builder setFilterBytes(ByteString value)

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

  • parent_entry

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

    You cannot use parent_entry in conjunction with other fields.

    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"
  • "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListEntriesRequest.Builder setPageSize(int value)

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

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)

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

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)

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

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListEntriesRequest.Builder

This builder for chaining.