Class ListGlossariesRequest.Builder (1.72.0)

public static final class ListGlossariesRequest.Builder extends GeneratedMessageV3.Builder<ListGlossariesRequest.Builder> implements ListGlossariesRequestOrBuilder

List Glossaries Request

Protobuf type google.cloud.dataplex.v1.ListGlossariesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListGlossariesRequest build()
Returns
Type Description
ListGlossariesRequest

buildPartial()

public ListGlossariesRequest buildPartial()
Returns
Type Description
ListGlossariesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListGlossariesRequest.Builder clearFilter()

Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are:

  • display_name="my-glossary"
  • categoryCount=1
  • termCount=0

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

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListGlossariesRequest.Builder clearOrderBy()

Optional. Order by expression that orders Glossaries listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

clearPageSize()

public ListGlossariesRequest.Builder clearPageSize()

Optional. The maximum number of Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

clearPageToken()

public ListGlossariesRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

clearParent()

public ListGlossariesRequest.Builder clearParent()

Required. The parent, which has this collection of Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

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

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListGlossariesRequest getDefaultInstanceForType()
Returns
Type Description
ListGlossariesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are:

  • display_name="my-glossary"
  • categoryCount=1
  • termCount=0

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are:

  • display_name="my-glossary"
  • categoryCount=1
  • termCount=0

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Order by expression that orders Glossaries listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Order by expression that orders Glossaries listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The maximum number of Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous ListGlossaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries 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. A page token, received from a previous ListGlossaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries 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 parent, which has this collection of Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent, which has this collection of Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

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(ListGlossariesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListGlossariesRequest.Builder setFilter(String value)

Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are:

  • display_name="my-glossary"
  • categoryCount=1
  • termCount=0

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListGlossariesRequest.Builder setFilterBytes(ByteString value)

Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are:

  • display_name="my-glossary"
  • categoryCount=1
  • termCount=0

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListGlossariesRequest.Builder setOrderBy(String value)

Optional. Order by expression that orders Glossaries listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListGlossariesRequest.Builder setOrderByBytes(ByteString value)

Optional. Order by expression that orders Glossaries listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListGlossariesRequest.Builder setPageSize(int value)

Optional. The maximum number of Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListGlossariesRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous ListGlossaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries 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
ListGlossariesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListGlossariesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous ListGlossaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries 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
ListGlossariesRequest.Builder

This builder for chaining.

setParent(String value)

public ListGlossariesRequest.Builder setParent(String value)

Required. The parent, which has this collection of Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListGlossariesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListGlossariesRequest.Builder setParentBytes(ByteString value)

Required. The parent, which has this collection of Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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