Class ListGlossaryTermsRequest.Builder (1.72.0)

public static final class ListGlossaryTermsRequest.Builder extends GeneratedMessageV3.Builder<ListGlossaryTermsRequest.Builder> implements ListGlossaryTermsRequestOrBuilder

List GlossaryTerms Request

Protobuf type google.cloud.dataplex.v1.ListGlossaryTermsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListGlossaryTermsRequest build()
Returns
Type Description
ListGlossaryTermsRequest

buildPartial()

public ListGlossaryTermsRequest buildPartial()
Returns
Type Description
ListGlossaryTermsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListGlossaryTermsRequest.Builder clearFilter()

Optional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryTerms that are directly nested under the specified parent.

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

Returns
Type Description
ListGlossaryTermsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListGlossaryTermsRequest.Builder clearOrderBy()

Optional. Order by expression that orders GlossaryTerms 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
ListGlossaryTermsRequest.Builder

This builder for chaining.

clearPageSize()

public ListGlossaryTermsRequest.Builder clearPageSize()

Optional. The maximum number of GlossaryTerms to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryTerms 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
ListGlossaryTermsRequest.Builder

This builder for chaining.

clearPageToken()

public ListGlossaryTermsRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListGlossaryTermsRequest.Builder

This builder for chaining.

clearParent()

public ListGlossaryTermsRequest.Builder clearParent()

Required. The parent, which has this collection of GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_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
ListGlossaryTermsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListGlossaryTermsRequest getDefaultInstanceForType()
Returns
Type Description
ListGlossaryTermsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryTerms that are directly nested under the specified parent.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryTerms that are directly nested under the specified parent.

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 GlossaryTerms 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 GlossaryTerms 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 GlossaryTerms to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryTerms 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 ListGlossaryTerms call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryTerms 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 ListGlossaryTerms call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryTerms 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 GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_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 GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_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(ListGlossaryTermsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListGlossaryTermsRequest.Builder setFilter(String value)

Optional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryTerms that are directly nested under the specified parent.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListGlossaryTermsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListGlossaryTermsRequest.Builder setFilterBytes(ByteString value)

Optional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields:

  • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryTerms that are directly nested under the specified parent.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListGlossaryTermsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListGlossaryTermsRequest.Builder setOrderBy(String value)

Optional. Order by expression that orders GlossaryTerms 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
ListGlossaryTermsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListGlossaryTermsRequest.Builder setOrderByBytes(ByteString value)

Optional. Order by expression that orders GlossaryTerms 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
ListGlossaryTermsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListGlossaryTermsRequest.Builder setPageSize(int value)

Optional. The maximum number of GlossaryTerms to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryTerms 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
ListGlossaryTermsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListGlossaryTermsRequest.Builder setPageToken(String value)

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

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListGlossaryTermsRequest.Builder setPageTokenBytes(ByteString value)

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

This builder for chaining.

setParent(String value)

public ListGlossaryTermsRequest.Builder setParent(String value)

Required. The parent, which has this collection of GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_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
ListGlossaryTermsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListGlossaryTermsRequest.Builder setParentBytes(ByteString value)

Required. The parent, which has this collection of GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_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
ListGlossaryTermsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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