Class ListPartitionsRequest.Builder (1.42.0)

public static final class ListPartitionsRequest.Builder extends GeneratedMessageV3.Builder<ListPartitionsRequest.Builder> implements ListPartitionsRequestOrBuilder

List metadata partitions request.

Protobuf type google.cloud.dataplex.v1.ListPartitionsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListPartitionsRequest build()
Returns
Type Description
ListPartitionsRequest

buildPartial()

public ListPartitionsRequest buildPartial()
Returns
Type Description
ListPartitionsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListPartitionsRequest.Builder clearFilter()

Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax:

  • logic operators: AND, OR
  • comparison operators: <, >, >=, <= ,=, !=
  • LIKE operators:
    • The right hand of a LIKE operator supports "." and "" for wildcard searches, for example "value1 LIKE ".oo.*"
  • parenthetical grouping: ( )

    Sample filter expression: `?filter="key1 < value1 OR key2 > value2"

    Notes:

  • Keys to the left of operators are case insensitive.

  • Partition results are sorted first by creation time, then by lexicographic order.
  • Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.

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

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListPartitionsRequest.Builder clearPageSize()

Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListPartitionsRequest.Builder clearPageToken()

Optional. Page token received from a previous ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

clearParent()

public ListPartitionsRequest.Builder clearParent()

Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

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

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListPartitionsRequest getDefaultInstanceForType()
Returns
Type Description
ListPartitionsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax:

  • logic operators: AND, OR
  • comparison operators: <, >, >=, <= ,=, !=
  • LIKE operators:
    • The right hand of a LIKE operator supports "." and "" for wildcard searches, for example "value1 LIKE ".oo.*"
  • parenthetical grouping: ( )

    Sample filter expression: `?filter="key1 < value1 OR key2 > value2"

    Notes:

  • Keys to the left of operators are case insensitive.

  • Partition results are sorted first by creation time, then by lexicographic order.
  • Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax:

  • logic operators: AND, OR
  • comparison operators: <, >, >=, <= ,=, !=
  • LIKE operators:
    • The right hand of a LIKE operator supports "." and "" for wildcard searches, for example "value1 LIKE ".oo.*"
  • parenthetical grouping: ( )

    Sample filter expression: `?filter="key1 < value1 OR key2 > value2"

    Notes:

  • Keys to the left of operators are case insensitive.

  • Partition results are sorted first by creation time, then by lexicographic order.
  • Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.

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 ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token.

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 ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token.

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 entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_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 resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListPartitionsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListPartitionsRequest.Builder setFilter(String value)

Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax:

  • logic operators: AND, OR
  • comparison operators: <, >, >=, <= ,=, !=
  • LIKE operators:
    • The right hand of a LIKE operator supports "." and "" for wildcard searches, for example "value1 LIKE ".oo.*"
  • parenthetical grouping: ( )

    Sample filter expression: `?filter="key1 < value1 OR key2 > value2"

    Notes:

  • Keys to the left of operators are case insensitive.

  • Partition results are sorted first by creation time, then by lexicographic order.
  • Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListPartitionsRequest.Builder setFilterBytes(ByteString value)

Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax:

  • logic operators: AND, OR
  • comparison operators: <, >, >=, <= ,=, !=
  • LIKE operators:
    • The right hand of a LIKE operator supports "." and "" for wildcard searches, for example "value1 LIKE ".oo.*"
  • parenthetical grouping: ( )

    Sample filter expression: `?filter="key1 < value1 OR key2 > value2"

    Notes:

  • Keys to the left of operators are case insensitive.

  • Partition results are sorted first by creation time, then by lexicographic order.
  • Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListPartitionsRequest.Builder setPageSize(int value)

Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListPartitionsRequest.Builder setPageToken(String value)

Optional. Page token received from a previous ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListPartitionsRequest.Builder setPageTokenBytes(ByteString value)

Optional. Page token received from a previous ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListPartitionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListPartitionsRequest.Builder setParent(String value)

Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_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
ListPartitionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListPartitionsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_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
ListPartitionsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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